class documentation

class ClosingLaterProtocol(ConnectableProtocol): (source)

View In Hierarchy

ClosingLaterProtocol exchanges one byte with its peer and then disconnects itself. This is mostly a work-around for the fact that connectionMade is called before the SSL handshake has completed.

Method __init__ Undocumented
Method connectionLost Called when the connection is shut down.
Method connectionMade Called when a connection is made.
Method dataReceived Called whenever data is received.
Instance Variable lostConnectionReason Undocumented
Instance Variable onConnectionLost Undocumented

Inherited from ConnectableProtocol:

Instance Variable disconnectReason The Failure passed to connectionLost.
Instance Variable reactor The reactor used in this test.
Method _setAttributes Set attributes on the protocol that are known only externally; this will be called by runProtocolsWithReactor when this protocol is instantiated.
Instance Variable _done A Deferred which will be fired when the connection is lost.

Inherited from Protocol (via ConnectableProtocol):

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

Inherited from BaseProtocol (via ConnectableProtocol, Protocol):

Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented
def __init__(self, onConnectionLost): (source)

Undocumented

def connectionLost(self, 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.

Parameters
reason:twisted.python.failure.FailureUndocumented
def connectionMade(self): (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.

def dataReceived(self, bytes): (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.

Parameters
bytesUndocumented
dataa string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.
lostConnectionReason = (source)

Undocumented

onConnectionLost = (source)

Undocumented