twisted.test.test_amp.TestProto

class documentation

class TestProto(protocol.Protocol): (source)

View In Hierarchy

A trivial protocol for use in testing where a Protocol is expected.

Method __init__ Undocumented
Method __repr__ Custom repr for testing to avoid coupling amp tests with repr from Protocol
Method connectionLost Called when the connection is shut down.
Method connectionMade Called when a connection is made.
Method dataReceived Called whenever data is received.
Class Variable instanceCount Undocumented
Instance Variable data Undocumented
Instance Variable dataToSend data to send on the protocol
Instance Variable instanceId the id of this instance
Instance Variable onConnLost deferred that will fired when the connection is lost

Inherited from Protocol:

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 Protocol):

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

Undocumented

def __repr__(self): (source)

Custom repr for testing to avoid coupling amp tests with repr from Protocol

Returns a string which contains a unique identifier that can be looked up using the instanceId property:

    <TestProto #3>
Returns
strUndocumented
def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.connectionLost

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)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.BaseProtocol.connectionMade

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)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.dataReceived

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.
instanceCount: int = (source)

Undocumented

data: list = (source)

Undocumented

dataToSend = (source)

data to send on the protocol

instanceId = (source)

the id of this instance

onConnLost = (source)

deferred that will fired when the connection is lost