twisted.conch.test.test_conch.ConchTestForwardingPort

class documentation

class ConchTestForwardingPort(protocol.Protocol): (source)

Connects to server launched by a third-party process (managed by ConchTestForwardingProcess) sends data, then reports whatever it received back to the ConchTestForwardingProcess once the connection is ended.

Method	`__init__`	No summary
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	`buffer`	Undocumented
Instance Variable	`data`	Undocumented
Instance Variable	`protocol`	Undocumented

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, protocol, data): (source) ¶

Parameters
protocol:`ConchTestForwardingProcess`	The `ProcessProtocol` which made this connection.
data:str	The data to be sent to the third-party server.

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.Failure`	Undocumented

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, data): (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
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.

buffer: bytes = (source) ¶

Undocumented

data = (source) ¶

Undocumented

protocol = (source) ¶

Undocumented