�
Ϫ�fYK � � � d Z ddlmZmZmZ ddlmZmZmZ ddl m
Z
ddl m Z m
Z
ddlmZmZ ddlmZ d� Zd � Z G d
� d � Z e
e j, � G d � d
� � Z e
e j0 e j2 e j4 e j6 e j8 � G d� dee� � Z efde de de fd�Z!de de fd�Z"g d�Z#y)z+
Support for generic select()able objects.
� )�AF_INET�AF_INET6� inet_pton)�Iterable�List�Optional)� implementer)�
interfaces�main)�failure�reflect)�
lazyByteSlicec �: � t | t � s t d� �y )NzData must be bytes)�
isinstance�bytes� TypeError)�objs �;/usr/lib/python3/dist-packages/twisted/internet/abstract.py�_dataMustBeBytesr s � � �c�5� !��,�-�-� "� c �D � dj t | � |d g|z � S )Nr )�join�
memoryview)�bObj�offset�bArrays r � _concatenater s% � � �8�8�Z��%�f�g�.�/�&�8� 9�9r c �. � e Zd ZdZdZdZdZd� Zd� Zd� Z y)�_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 � � t d� �)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 startWriting��NotImplementedError��selfs r � startWritingz_ConsumerMixin.startWritingL s � � "�"E�F�Fr c �� � | j � t d|�d| j �d�� �| j r|j � y|| _ || _ |s|j � yy)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.
NzCannot register producer z, because producer z was never unregistered.)�producer� RuntimeError� disconnected�
stopProducing�streamingProducer�resumeProducing)r$ r' � streamings r �registerProducerz _ConsumerMixin.registerProducerU sc � � �=�=� $� �#+�T�]�]�<��
� � � � � "� "� $� $�D�M�%.�D� "� ��(�(�*� r c �f � d| _ | j r | j r| j � yyy)zM
Stop consuming data from a producer, without disconnecting.
N)r' � connected�
disconnectingr% r# s r �unregisterProducerz!_ConsumerMixin.unregisterProducerr s- � � ��
� �>�>�d� 0� 0� � � � � 1�>r )
�__name__�
__module__� __qualname__�__doc__r' �producerPausedr+ r% r. r2 � r r r r ! s* � �$�L �H��N� ��G�+�: r r c �& � e Zd ZdZdedefd�Zd� Zy)� _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.
�applicationObject�returnc � � t j j |� r|j � S |j j
S )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
�ILoggingContext�
providedBy� logPrefix� __class__r3 )r$ r; s r �
_getLogPrefixz_LogOwner._getLogPrefix� s: � � � %� %� 0� 0�1B� C�$�.�.�0� 0� �*�*�3�3�3r c � � y)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.
�-r8 r# s r r@ z_LogOwner.logPrefix� s � � r N)r3 r4 r5 r6 �object�strrB r@ r8 r r r: r: { s � ��
4�v�
4�#�
4�r r: c �8 � e Zd ZdZdZdZdZdZdZdZ dZ
dZ d'de e
j fd�Zd � Zd
ed dfd �Zd
� Zd� Zd� Zd� Zd� Zdej2 d dfd�Zd� Zd� Z d� Z d� Z d
ed dfd�Z de e d dfd�Z!d� Z"d � Z#d � Z$d � Z%d � Z&d � Z'dZ(d!Z)d"� Z*d#� Z+d$� Z,d%� Z-d&� Z.y)(�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 N�reactorc �B � |sddl m} |}|| _ g | _ d| _ y)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 )rI N)�twisted.internetrI �_tempDataBuffer� _tempDataLen)r$ rI �_reactors r �__init__zFileDescriptor.__init__� s& � � � <� �G� �� �,.�� � ��r c � � d| _ d| _ | j �!| j j � d| _ | j � | j � y)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) r0 r' r* � stopReading� stopWriting�r$ �reasons r �connectionLostz FileDescriptor.connectionLost� sL � � ������ �=�=� $� �M�M� '� '� )� �D�M� ���� ���r �datar< c �X � t dt j | j � z � �)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 writeSomeData�r" r
�qualrA �r$ rW s r �
writeSomeDataz FileDescriptor.writeSomeData� s& � � "� 1�G�L�L�� � �4P� P�
�
r c �X � t dt j | j � z � �)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 doReadrY r# s r �doReadzFileDescriptor.doRead� s& � � "� *�W�\�\�$�.�.�-I� I�
�
r c � � t | j � | j z
| j k rEt | j | j | j
� | _ d| _ g | _ d| _ | j r0| j t | j | j � � }n| j | j � }t |t � s|dk r|S | xj |z
c_ | j t | j � k( r�| j s�d| _ d| _ | j � | j �:| j r | j r"d| _ | j j � y| j r| j# � S | j$ rd| _ | j) � }|S y)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 rL rM r\ r r � ExceptionrS r' r+ r7 r, r1 �_postLoseConnection�_writeDisconnecting�_writeDisconnected�_closeWriteConnection)r$ �l�results r �doWritezFileDescriptor.doWrite� su � � �t��� �$�+�+� -���� ?� +�������d�.B�.B� �D�O� �D�K�#%�D� � !�D� � �;�;��"�"�=�� � �$�+�+�#N�O�A��"�"�4�?�?�3�A� �a�� #�q�1�u��H� � � �q�� � �;�;�#�d�o�o�.� .�t�7H�7H� !�D�O��D�K� � � � ��}�}�(��+�+��0C�0C� ',��#��
�
�-�-�/� � �#�#� �/�/�1�1��)�)�
+/��'� �3�3�5�� �
�r c �" � t j S )z�Called after a loseConnection(), when all data has been written.
Whatever this returns is then returned by doWrite.
)r �CONNECTION_DONEr# s r rd z"FileDescriptor._postLoseConnection' s � � �#�#�#r c � � y �Nr8 r# s r rg z$FileDescriptor._closeWriteConnection/ s � � r c �& � | j |� y rn �rV rT s r �writeConnectionLostz"FileDescriptor.writeConnectionLost3 � � � ���F�#r rU c �& � | j |� y rn rp rT s r �readConnectionLostz!FileDescriptor.readConnectionLost7 rr r c � � t � �rn r! r# s r �getHostzFileDescriptor.getHost; � � �!�#�#r c � � t � �rn r! r# s r �getPeerzFileDescriptor.getPeer? rw r c �` � t | j � | j z | j kD S )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.
)r` ra rM �
bufferSizer# s r �_isSendBufferFullz FileDescriptor._isSendBufferFullC s' � � �4�?�?�#�d�&7�&7�7�$�/�/�I�Ir c � � | j �@| j r3| j � r"d| _ | j j � yyyy)zY
Possibly pause a producer, if there is one and the send buffer is full.
NT)r' r+ r| r7 �pauseProducingr# s r �_maybePauseProducerz"FileDescriptor._maybePauseProducerP sH � �
�=�=� $��)?�)?��%�%�'�&*��#��
�
�,�,�.� (� *@� $r c � � t |� | j r | j ry|rZ| j j |� | xj
t
|� z
c_ | j � | j � yy)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.
N) r r0 rf rL �appendrM r` r r% r[ s r �writezFileDescriptor.write\ sg � � �� ��~�~��!8�!8� � � � � � '� '�� -� � � ��T�� *� � � $� $� &� � � � � r �iovecc � � |D ]
}t |� � | j r|r | j ry| j j |� |D ] }| xj
t
|� z
c_ �" | j � | j � y)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.
N) r r0 rf rL �extendrM r` r r% )r$ r� �is r �
writeSequencez FileDescriptor.writeSequencem s � � � �A� �Q� � ��~�~�U�d�.E�.E� � � � �#�#�E�*�� (�A� � � ��Q�� '� � (� � � �"� ���r c �D � | j r�| j s�| j rS| j � | j � | j t
j t j � � y| j � | j � d| _ yyy)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.
rQ N) r0 r1 rf rR rS rV r �Failurer rl r% r# s r �loseConnectionz FileDescriptor.loseConnection� sx � � �>�>�$�"4�"4��&�&�� � �"�� � �"��#�#�G�O�O�D�4H�4H�$I�J�� � �"��!�!�#�%&��"� #5�>r c �2 � d| _ | j � y )NT)re r% r# s r �loseWriteConnectionz"FileDescriptor.loseWriteConnection� s � �#'�� � ���r c �: � | j j | � y)z�Stop waiting for read availability.
Call this to remove this selectable from being notified when it is
ready for reading.
N)rI � removeReaderr# s r rR zFileDescriptor.stopReading� � � �
� � �!�!�$�'r c �: � | j j | � y)z�Stop waiting for write availability.
Call this to remove this selectable from being notified when it is ready
for writing.
N)rI � removeWriterr# s r rS zFileDescriptor.stopWriting� r� r c �: � | j j | � y)z$Start waiting for read availability.N)rI � addReaderr# s r � startReadingzFileDescriptor.startReading� s � � � � � � �t�$r c �: � | j j | � y)z�Start waiting for write availability.
Call this to have this FileDescriptor be notified whenever it is ready for
writing.
N)rI � addWriterr# s r r% zFileDescriptor.startWriting� s � �
� � � � �t�$r i c �D � | j � | j � y)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)r2 r� r# s r �
stopConsumingz FileDescriptor.stopConsuming� s � �
� � �!� ��� r c �X � | j r | j s| j � y y y rn )r0 r1 r� r# s r r, z FileDescriptor.resumeProducing� s$ � � �>�>�$�"4�"4� � � � � #5�>r c �$ � | j � y rn )rR r# s r r~ z FileDescriptor.pauseProducing� s � � ���r c �$ � | j � y rn )r� r# s r r* z FileDescriptor.stopProducing� s � � ��� r c � � y)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.
���r8 r# s r �filenozFileDescriptor.fileno� s � � r rn )/r3 r4 r5 r6 r0 r) r1 re rf ra r rb r r
�
IReactorFDSetrO rV r r\ r^ rj rd rg rq r r� rt rv ry r| r r� r r� r� r� rR rS r� r% r' r{ r� r, r~ r* r� r8 r r rH rH � s � �� �I��L��M� �� ���J�
�F��J�
���)A�)A� B�
� �$
�%�
�D�
�
�9�v$�
�$�$�� � � $�T� $�$�$� J�
/� �%� �D� �" �8�E�?� �t� �4'�2 �(�(�%�%� �H��J� � �� �r rH �addr�familyr< c �@ � t | t � r | j d� } |t k( r| j dd� d } n,|t k( r| j d� dk7 ryt d|��� � t || � y # t $ r Y yw xY w# t t f$ r Y yw xY w)
a>
Determine whether the given string represents an IP address of the given
family; by default, an IPv4 address.
@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.)
@return: C{True} if C{addr} represents an IPv4 address, C{False} otherwise.
�asciiF�%rQ r �.� zunknown address family T) r r �decode�UnicodeDecodeErrorr �splitr �count�
ValueErrorr �OSError)r� r� s r � isIPAddressr� � s� � � �$�� � ��;�;�w�'�D� ��� �z�z�#�q�!�!�$�� �7� � �:�:�c�?�a� ���2�6�*�=�>�>�� �&�$� � ��) "� �� ��$
�� � ���s# �A< �/ B �< B�B� B � B c �" � 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}
)r� r )r� s r �
isIPv6Addressr� s � � �t�X� &�&r )rH r� r� N)$r6 �socketr r r �typingr r r �zope.interfacer rK r
r �twisted.pythonr r
�twisted.python.compatr r r r r> r: �
IPushProducer�IReadWriteDescriptor� IConsumer�
ITransport�IHalfCloseableDescriptorrH rF �int�boolr� r� �__all__r8 r r �<module>r� s� ��
�
0� /� +� +� &� -� +� 0�.�:�W � W �t
�Z�
'�
'�(�� � )��8
�� � ��#�#��������'�'� �E�^�Y� E��E�P
*1� %�c� %�3� %�T� %�P '�� '�� '� =�r |