twisted.internet.protocol.ConsumerToProtocolAdapter(components.Adapter) class documentationtwisted.internet.protocol
View Source
(View In Hierarchy)
Implements interfaces: twisted.internet.interfaces.IProtocol
| 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. |
Inherited from Adapter:
| Class Variable | temporaryAdapter | If this is True, the adapter will not be persisted on the Componentized. |
| Class Variable | multiComponent | If this adapter is persistent, should it be automatically registered for all appropriate interfaces. |
| Method | __init__ | Set my 'original' attribute to be the object I am adapting. |
| Method | __conform__ | I forward __conform__ to self.original if it has it, otherwise I simply return None. |
| Method | isuper | Forward isuper to self.original |
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 | data | a 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. |
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).
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.