twisted.internet.endpoints._WrappingFactory : API documentation

Wrap a factory in order to wrap the protocols it builds.

Instance Variables	_wrappedFactory	A provider of IProtocolFactory whose buildProtocol method will be called and whose resulting protocol will be wrapped.
	_onConnection	An `Deferred` that fires when the protocol is connected

Method	__init__	No summary
Method	doStart	Start notifications are passed straight through to the wrapped factory.
Method	doStop	Stop notifications are passed straight through to the wrapped factory.
Method	buildProtocol	Proxy `buildProtocol` to our `self._wrappedFactory` or errback the `self._onConnection` `Deferred`.
Method	clientConnectionFailed	Errback the `self._onConnection` `Deferred` when the client connection fails.

Inherited from ClientFactory:

Method	startedConnecting	Called when a connection has been started.
Method	clientConnectionLost	Called when an established connection is lost.

Inherited from Factory (via ClientFactory):

Method	logPrefix	Describe this factory for log messages.
Method	startFactory	This will be called before I begin listening on a Port or Connector.
Method	stopFactory	This will be called before I stop listening on all Ports/Connectors.

def __init__(self, wrappedFactory, canceller): (source)

Parameters	wrappedFactory	A provider of IProtocolFactory whose buildProtocol method will be called and whose resulting protocol will be wrapped.
	canceller	An object that will be called to cancel the `self._onConnection` `Deferred`

def buildProtocol(self, addr): (source)

Proxy buildProtocol to our self._wrappedFactory or errback the self._onConnection Deferred.

Returns An instance of _WrappingProtocol or None

def clientConnectionFailed(self, connector, reason): (source)

Errback the self._onConnection Deferred when the client connection fails.

t.i.e._WrappingFactory(ClientFactory) : class documentation