interface documentation

class twisted.internet.interfaces.IFileDescriptor(ILoggingContext): (source)

Known subclasses: twisted.internet.interfaces.IReadDescriptor, twisted.internet.interfaces.IWriteDescriptor

View In Hierarchy

An interface representing a UNIX-style numeric file descriptor.

Method fileno No summary
Method connectionLost Called when the connection was lost.

Inherited from ILoggingContext:

Method logPrefix
def fileno(): (source)
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. (type: object)
def connectionLost(reason): (source)

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. (type: Failure)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.