← Back
Editing: abstract.cpython-38.pyc
U W[JK � @ s d Z ddlmZmZ ddlmZmZmZmZ ddl m Z ddl m Z m Z mZ ddlmZmZ ddlmZmZ erzdd � Zndd lmZ d d � ZG d d � d e�Ze ej�G dd� de��Ze ej ej ej ej ej �G dd� dee��Z!efdd�Z"dd� Z#dddgZ$dS )z+ Support for generic select()able objects. � )�division�absolute_import)�AF_INET�AF_INET6� inet_pton�error)� implementer)�unicode� lazyByteSlice�_PY3)�reflect�failure)� interfaces�mainc C s d� t| �|d � g| �S �N� )�join� memoryview�ZbObj�offsetZbArray� r �;/usr/lib/python3/dist-packages/twisted/internet/abstract.py� _concatenate s r )�bufferc C s t | |�d�|� S r )r r r r r r r s c @ s4 e Zd ZdZdZdZdZdd� Zdd� Zdd � Z dS ) �_ConsumerMixina� L{IConsumer} implementations can mix this in to get C{registerProducer} and C{unregisterProducer} methods which take care of keeping track of a producer's state. Subclasses must provide three attributes which L{_ConsumerMixin} will read but not write: - connected: A C{bool} which is C{True} as long as the consumer has someplace to send bytes (for example, a TCP connection), and then C{False} when it no longer does. - disconnecting: A C{bool} which is C{False} until something like L{ITransport.loseConnection} is called, indicating that the send buffer should be flushed and the connection lost afterwards. Afterwards, C{True}. - disconnected: A C{bool} which is C{False} until the consumer no longer has a place to send bytes, then C{True}. Subclasses must also override the C{startWriting} method. @ivar producer: L{None} if no producer is registered, otherwise the registered producer. @ivar producerPaused: A flag indicating whether the producer is currently paused. @type producerPaused: L{bool} @ivar streamingProducer: A flag indicating whether the producer was registered as a streaming (ie push) producer or not (ie a pull producer). This will determine whether the consumer may ever need to pause and resume it, or if it can merely call C{resumeProducing} on it when buffer space is available. @ivar streamingProducer: C{bool} or C{int} NFc C s t d��dS )a Override in a subclass to cause the reactor to monitor this selectable for write events. This will be called once in C{unregisterProducer} if C{loseConnection} has previously been called, so that the connection can actually close. z!%r did not implement startWritingN)�NotImplementedError��selfr r r � startWritingM s z_ConsumerMixin.startWritingc C sH | j dk r td|| j f ��| jr,|�� n|| _ || _|sD|�� dS )a" Register to receive data from a producer. This sets this selectable to be a consumer for a producer. When this selectable runs out of data on a write() call, it will ask the producer to resumeProducing(). When the FileDescriptor's internal data buffer is filled, it will ask the producer to pauseProducing(). If the connection is lost, FileDescriptor calls producer's stopProducing() method. If streaming is true, the producer should provide the IPushProducer interface. Otherwise, it is assumed that producer provides the IPullProducer interface. In this case, the producer won't be asked to pauseProducing(), but it has to be careful to write() data only when its resumeProducing() method is called. NzHCannot register producer %s, because producer %s was never unregistered.)�producer� RuntimeError� disconnected� stopProducing�streamingProducer�resumeProducing)r r Z streamingr r r �registerProducerW s �� z _ConsumerMixin.registerProducerc C s d| _ | jr| jr| �� dS )zM Stop consuming data from a producer, without disconnecting. N)r � connected� disconnectingr r r r r �unregisterProducert s z!_ConsumerMixin.unregisterProducer) �__name__� __module__� __qualname__�__doc__r �producerPausedr# r r% r( r r r r r # s % r c @ s e Zd ZdZdd� Zdd� ZdS )� _LogOwnerz� Mixin to help implement L{interfaces.ILoggingContext} for transports which have a protocol, the log prefix of which should also appear in the transport's log prefix. c C s t j�|�r|�� S |jjS )z� Determine the log prefix to use for messages related to C{applicationObject}, which may or may not be an L{interfaces.ILoggingContext} provider. @return: A C{str} giving the log prefix to use. )r �ILoggingContextZ providedBy� logPrefix� __class__r) )r ZapplicationObjectr r r � _getLogPrefix� s z_LogOwner._getLogPrefixc C s dS )z� Override this method to insert custom logging behavior. Its return value will be inserted in front of every line. It may be called more times than the number of output lines. �-r r r r r r0 � s z_LogOwner.logPrefixN)r) r* r+ r, r2 r0 r r r r r. ~ s r. c @ s e Zd ZdZdZdZdZdZdZdZ dZ dZ d8dd�Z d d � Z d d � Zd d� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd � Zd d � Zd d � Ze�ej �fd!d"�Z d#d$� Z d%d&� Z d'd(� Z d)d*� Z!d+d,� Z"dZ#d-Z$d.d/� Z%d0d1� Z&d2d3� Z'd4d5� Z(d6d7� Z)dS )9�FileDescriptorz� An object which can be operated on by select(). This is an abstract superclass of all objects which may be notified when they are readable or writable; e.g. they have a file-descriptor that is valid to be passed to select(2). r Fr i Nc C s& |sddl m} || _g | _d| _dS )z� @param reactor: An L{IReactorFDSet} provider which this descriptor will use to get readable and writeable event notifications. If no value is given, the global reactor will be used. r )�reactorN)�twisted.internetr5 �_tempDataBuffer� _tempDataLen)r r5 r r r �__init__� s zFileDescriptor.__init__c C s: d| _ d| _| jdk r&| j�� d| _| �� | �� dS )az The connection was lost. This is called when the connection on a selectable object has been lost. It will be called whether the connection was closed explicitly, an exception occurred in an event handler, or the other end of the connection closed it first. Clean up state here, but make sure to call back up to FileDescriptor. � r N)r! r& r r" � stopReading� stopWriting�r �reasonr r r �connectionLost� s z FileDescriptor.connectionLostc C s t dt�| j� ��dS )a� Write as much as possible of the given data, immediately. This is called to invoke the lower-level writing functionality, such as a socket's send() method, or a file's write(); this method returns an integer or an exception. If an integer, it is the number of bytes written (possibly zero); if an exception, it indicates the connection was lost. z#%s does not implement writeSomeDataN�r r Zqualr1 �r �datar r r � writeSomeData� s �z FileDescriptor.writeSomeDatac C s t dt�| j� ��dS )z� Called when data is available for reading. Subclasses must override this method. The result will be interpreted in the same way as a result of doWrite(). z %s does not implement doReadNr@ r r r r �doRead� s �zFileDescriptor.doReadc C s t | j�| j | jk r<t| j| j| j�| _d| _g | _d| _| jrX| �t| j| j��}n | �| j�}t |t �sv|dk rz|S | j|7 _| jt | j�k�r| j�sd| _d| _| � � | j dk r�| j r�| jr�d| _| j �� n(| jr�| �� S | j�rd| _| �� }|S dS )z� Called when data can be written. @return: L{None} on success, an exception or a negative integer on failure. @see: L{twisted.internet.interfaces.IWriteDescriptor.doWrite}. r r NFT)�len� dataBufferr � SEND_LIMITr r7 r8 rC r � isinstance� Exceptionr< r r# r- r$ r' �_postLoseConnection�_writeDisconnecting�_writeDisconnected�_closeWriteConnection)r �l�resultr r r �doWrite� s> � � zFileDescriptor.doWritec C s t jS )z�Called after a loseConnection(), when all data has been written. Whatever this returns is then returned by doWrite. )r �CONNECTION_DONEr r r r rJ $ s z"FileDescriptor._postLoseConnectionc C s d S �Nr r r r r rM , s z$FileDescriptor._closeWriteConnectionc C s | � |� d S rR �r? r= r r r �writeConnectionLost0 s z"FileDescriptor.writeConnectionLostc C s | � |� d S rR rS r= r r r �readConnectionLost4 s z!FileDescriptor.readConnectionLostc C s t | j�| j | jkS )ay Determine whether the user-space send buffer for this transport is full or not. When the buffer contains more than C{self.bufferSize} bytes, it is considered full. This might be improved by considering the size of the kernel send buffer and how much of it is free. @return: C{True} if it is full, C{False} otherwise. )rE rF r8 � bufferSizer r r r �_isSendBufferFull9 s z FileDescriptor._isSendBufferFullc C s, | j dk r(| jr(| �� r(d| _| j �� dS )zY Possibly pause a producer, if there is one and the send buffer is full. NT)r r# rW r- �pauseProducingr r r r �_maybePauseProducerG s z"FileDescriptor._maybePauseProducerc C sX t |t�rtd��| jr | jr"dS |rT| j�|� | jt|�7 _| � � | � � dS )a7 Reliably write some data. The data is buffered until the underlying file descriptor is ready for writing. If there is more than C{self.bufferSize} data in the buffer and this descriptor has a registered streaming producer, its C{pauseProducing()} method will be called. �Data must not be unicodeN) rH r � TypeErrorr& rL r7 �appendr8 rE rY r rA r r r �writeT s zFileDescriptor.writec C sl |D ]}t |t�rtd��q| jr,|r,| jr0dS | j�|� |D ]}| jt|�7 _q@| � � | � � dS )a Reliably write a sequence of data. Currently, this is a convenience method roughly equivalent to:: for chunk in iovec: fd.write(chunk) It may have a more efficient implementation at a later time or in a different reactor. As with the C{write()} method, if a buffer size limit is reached and a streaming producer is registered, it will be paused until the buffered data is written to the underlying file descriptor. rZ N) rH r r[ r& rL r7 �extendr8 rE rY r )r Ziovec�ir r r � writeSequenceg s z FileDescriptor.writeSequencec C sH | j rD| jsD| jr.| �� | �� | �|� n| �� | �� d| _dS )a[ Close the connection at the next available opportunity. Call this to cause this FileDescriptor to lose its connection. It will first write any data that it has buffered. If there is data buffered yet to be written, this method will cause the transport to lose its connection as soon as it's done flushing its write buffer. If you have a producer registered, the connection won't be closed until the producer is finished. Therefore, make sure you unregister your producer when it's finished, or the connection will never close. r: N)r& r' rL r; r< r? r )r Z _connDoner r r �loseConnection� s z FileDescriptor.loseConnectionc C s d| _ | �� d S )NT)rK r r r r r �loseWriteConnection� s z"FileDescriptor.loseWriteConnectionc C s | j �| � dS )z�Stop waiting for read availability. Call this to remove this selectable from being notified when it is ready for reading. N)r5 Z removeReaderr r r r r; � s zFileDescriptor.stopReadingc C s | j �| � dS )z�Stop waiting for write availability. Call this to remove this selectable from being notified when it is ready for writing. N)r5 Z removeWriterr r r r r< � s zFileDescriptor.stopWritingc C s | j �| � dS )z-Start waiting for read availability. N)r5 Z addReaderr r r r � startReading� s zFileDescriptor.startReadingc C s | j �| � dS )z�Start waiting for write availability. Call this to have this FileDescriptor be notified whenever it is ready for writing. N)r5 Z addWriterr r r r r � s zFileDescriptor.startWritingi c C s | � � | �� dS )z�Stop consuming data. This is called when a producer has lost its connection, to tell the consumer to go lose its connection (and break potential circular references). N)r( ra r r r r � stopConsuming� s z FileDescriptor.stopConsumingc C s | j r| js| �� d S rR )r& r' rc r r r r r$ � s z FileDescriptor.resumeProducingc C s | � � d S rR )r; r r r r rX � s z FileDescriptor.pauseProducingc C s | � � d S rR )ra r r r r r" � s z FileDescriptor.stopProducingc C s dS )z�File Descriptor number for select(). This method must be overridden or assigned in subclasses to indicate a valid file descriptor for the operating system. ���r r r r r �fileno� s zFileDescriptor.fileno)N)*r) r* r+ r, r& r! r' rK rL rF r rG r9 r? rC rD rP rJ rM rT rU rW rY r] r` r ZFailurer rQ ra rb r; r< rc r r rV rd r$ rX r" rf r r r r r4 � sF 9 r4 c C s� t | t�r0z| �d�} W n tk r. Y dS X |tkrJ| �dd�d } n*|tkrf| �d�dkrtdS ntd� |���zt || � W n tt fk r� Y dS X d S ) a� Determine whether the given string represents an IP address of the given family; by default, an IPv4 address. @type addr: C{str} @param addr: A string which may or may not be the decimal dotted representation of an IPv4 address. @param family: The address family to test for; one of the C{AF_*} constants from the L{socket} module. (This parameter has only been available since Twisted 17.1.0; previously L{isIPAddress} could only test for IPv4 addresses.) @type family: C{int} @rtype: C{bool} @return: C{True} if C{addr} represents an IPv4 address, C{False} otherwise. �asciiF�%r: r �.� zunknown address family {!r}T) rH �bytes�decode�UnicodeDecodeErrorr �splitr �count� ValueError�formatr r )�addrZfamilyr r r � isIPAddress� s rs c C s t | t�S )a2 Determine whether the given string represents an IPv6 address. @param addr: A string which may or may not be the hex representation of an IPv6 address. @type addr: C{str} @return: C{True} if C{addr} represents an IPv6 address, C{False} otherwise. @rtype: C{bool} )rs r )rr r r r � isIPv6Address s rt N)%r, Z __future__r r Zsocketr r r r Zzope.interfacer Ztwisted.python.compatr r r Ztwisted.pythonr r r6 r r r Z __builtin__r �objectr r/ r. Z IPushProducerZIReadWriteDescriptorZ IConsumerZ ITransportZIHalfCloseableDescriptorr4 rs rt �__all__r r r r �<module> s4 [ � G -
Save File
Cancel