class documentation
class _WrappingFactory(ClientFactory): (source)
Constructor: _WrappingFactory(wrappedFactory)
Wrap a factory in order to wrap the protocols it builds.
Method | __init__ |
No summary |
Method | build |
Proxy buildProtocol to our self._wrappedFactory or errback the self._onConnection Deferred if the wrapped factory raises an exception or returns None . |
Method | client |
Errback the self._onConnection Deferred when the client connection fails. |
Method | do |
Start notifications are passed straight through to the wrapped factory. |
Method | do |
Stop notifications are passed straight through to the wrapped factory. |
Method | started |
A connection attempt was started. Remember the connector which started said attempt, for use later. |
Method | _canceller |
The outgoing connection attempt was cancelled. Fail that Deferred with an error.ConnectingCancelledError . |
Instance Variable | _connector |
A connector that is managing the current or previous connection attempt. |
Instance Variable | _on |
A Deferred that fires when the protocol is connected |
Instance Variable | _wrapped |
A provider of IProtocolFactory whose buildProtocol method will be called and whose resulting protocol will be wrapped. |
Inherited from ClientFactory
:
Method | client |
Called when an established connection is lost. |
Inherited from Factory
(via ClientFactory
):
Class Method | for |
Create a factory for the given protocol. |
Method | log |
Describe this factory for log messages. |
Method | start |
This will be called before I begin listening on a Port or Connector. |
Method | stop |
This will be called before I stop listening on all Ports/Connectors. |
Class Variable | noisy |
Undocumented |
Class Variable | protocol |
Undocumented |
Instance Variable | num |
Undocumented |
Parameters | |
wrappedIProtocolFactory | A provider of IProtocolFactory whose buildProtocol method will be called and whose resulting protocol will be wrapped. |
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 |
overrides
twisted.internet.protocol.Factory.doStop
Stop notifications are passed straight through to the wrapped factory.
The outgoing connection attempt was cancelled. Fail that Deferred
with an error.ConnectingCancelledError
.
Parameters | |
deferred:Deferred | The Deferred that was cancelled; should be the same as self._onConnection. |
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. |