twisted.test.proto_helpers.AccumulatingProtocol(protocol.Protocol) class documentationtwisted.test.proto_helpers
View Source
(View In Hierarchy)
AccumulatingProtocol
is an IProtocol
implementation which collects the data delivered to it and can fire a
Deferred when it is connected or disconnected.
| Instance Variable | made | A flag indicating whether connectionMade has been called. |
| Instance Variable | data | Bytes giving all the data passed to dataReceived. |
| Instance Variable | closed | A flag indicated whether connectionLost has been called. |
| Instance Variable | closedReason | The value of the reason parameter passed to
connectionLost. |
| Instance Variable | closedDeferred | If set to a Deferred, this
will be fired when connectionLost is called. |
| Method | connectionMade | Called when a connection is made. |
| Method | dataReceived | Called whenever data is received. |
| Method | connectionLost | Called when the connection is shut down. |
Inherited from Protocol:
| Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol (via Protocol):
| Method | makeConnection | Make a connection to a transport and a server. |
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.
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.