class _WrappingFactory(ClientFactory): (source)
Wrap a factory in order to wrap the protocols it builds.
Method | __init__ |
|
Method | startedConnecting |
A connection attempt was started. Remember the connector which started said attempt, for use later. |
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 if the wrapped factory raises an exception or returns None . |
Method | clientConnectionFailed |
Errback the self._onConnection Deferred when the client connection fails. |
Instance Variable | _wrappedFactory |
A provider of IProtocolFactory whose buildProtocol method will be called and whose resulting protocol will be wrapped. |
Instance Variable | _onConnection |
A Deferred that fires when the protocol is connected |
Instance Variable | _connector |
A connector that is managing the current or previous connection attempt. |
Method | _canceller |
The outgoing connection attempt was cancelled. Fail that Deferred with an error.ConnectingCancelledError . |
Inherited from ClientFactory
:
Method | clientConnectionLost |
Called when an established connection is lost. |
Inherited from Factory
(via ClientFactory
):
Class Variable | protocol |
Undocumented |
Instance Variable | numPorts |
Undocumented |
Class Variable | noisy |
Undocumented |
Class Method | forProtocol |
Create a factory for the given protocol. |
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. |
Parameters | wrappedFactory | A provider of IProtocolFactory whose buildProtocol method will be called and whose resulting protocol will be wrapped. |
The outgoing connection attempt was cancelled. Fail that Deferred
with an error.ConnectingCancelledError
.
Parameters | deferred | The Deferred that was cancelled; should be the same as self._onConnection . (type: Deferred ) |
Returns | None | |
Note | This relies on startedConnecting having been called, so it may seem as though there's a race condition where _connector may not have been set. However, using public APIs, this condition is impossible to catch, because a connection API (connectTCP /SSL /UNIX ) is always invoked before a _WrappingFactory 's Deferred is returned to connect() 's caller. |
twisted.internet.protocol.Factory.doStop
Stop notifications are passed straight through to the wrapped factory.
Proxy buildProtocol
to our self._wrappedFactory
or errback the self._onConnection
Deferred
if the wrapped factory raises an exception or returns None
.
Returns | An instance of _WrappingProtocol or None |