Implements interfaces: twisted.internet.interfaces.IReadDescriptor

A read descriptor which removes itself from the reactor as soon as it gets a chance to do a read and keeps track of when its own fileno method is called.

Instance Variable insideReactor A flag which is true as long as the reactor has this descriptor as a reader.
Instance Variable calls A list of the bottom of the call stack for any call to fileno when insideReactor is false.
Method __init__ Undocumented
Method start Undocumented
Method logPrefix
Method doRead Some data is available for reading on your descriptor.
Method fileno
Method connectionLost Called when the connection was lost.
insideReactor =
A flag which is true as long as the reactor has this descriptor as a reader.
calls =
A list of the bottom of the call stack for any call to fileno when insideReactor is false.
def __init__(self, reactor):
Undocumented
def start(self):
Undocumented
def logPrefix(self):
ReturnsPrefix used during log formatting to indicate context. (type: str)
def doRead(self):

Some data is available for reading on your descriptor.

ReturnsIf an error is encountered which causes the descriptor to no longer be valid, a Failure should be returned. Otherwise, None.
def fileno(self):
ReturnsThe platform-specified representation of a file descriptor number. Or -1 if the descriptor no longer has a valid file descriptor number associated with it. As long as the descriptor is valid, calls to this method on a particular instance must return the same value.
RaisesIf the descriptor no longer has a valid file descriptor number associated with it.
def connectionLost(self, reason):

Called when 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.

See also IHalfCloseableDescriptor if your descriptor wants to be notified separately of the two halves of the connection being closed.

ParametersreasonA failure instance indicating the reason why the connection was lost. error.ConnectionLost and error.ConnectionDone are of special note, but the failure may be of other classes as well.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.