interface documentation

class twisted.internet.interfaces.IProtocol(Interface): (source)

Known subclasses: twisted.conch.telnet.ITelnetProtocol

Known implementations: twisted.internet.protocol.ConsumerToProtocolAdapter, twisted.internet.protocol.Protocol, twisted.web._http2.H2Connection

View In Hierarchy


Method dataReceived Called whenever data is received.
Method connectionLost Called when the connection is shut down.
Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.
def dataReceived(data): (source)

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

Please keep in mind that you will probably need to buffer some data as partial (or multiple) protocol messages may be received! We recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

Parametersdatabytes of indeterminate length (type: bytes)
def connectionLost(reason): (source)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed. The reason Failure wraps a twisted.internet.error.ConnectionDone or twisted.internet.error.ConnectionLost instance (or a subclass of one of those).

ParametersreasonUndocumented (type: Failure)
def makeConnection(transport): (source)

Make a connection to a transport and a server.

ParameterstransportUndocumented (type: ITransport)
def connectionMade(): (source)

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.