class documentation

class SingleUseMemoryEndpoint: (source)

Implements interfaces: twisted.internet.interfaces.IStreamClientEndpoint

View In Hierarchy

SingleUseMemoryEndpoint is a client endpoint which allows one connection to be set up and then exposes an API for moving around bytes related to that connection.

Method __init__ No summary
Method connect Connect the protocolFactory to the location specified by this IStreamClientEndpoint provider.
Instance Variable pump None until a connection is attempted, then a IOPump instance associated with the protocol which is connected.
Instance Variable _server Undocumented
def __init__(self, server): (source)
Parameters
server:IProtocol providerAn IProtocol provider to which the client will be connected.
def connect(self, factory): (source)

Connect the protocolFactory to the location specified by this IStreamClientEndpoint provider.

Parameters
factoryUndocumented
protocolFactoryA provider of IProtocolFactory
Returns
A Deferred that results in an IProtocol upon successful connection otherwise a Failure wrapping ConnectError or NoProtocol.
pump: IOPump = (source)

None until a connection is attempted, then a IOPump instance associated with the protocol which is connected.

Undocumented