Trees       Index       Help   

Zenoss

Package twisted :: Package internet :: Module protocol :: Class ReconnectingClientFactory
[show private | hide private]
[frames | no frames]

Class ReconnectingClientFactory

  Factory --+    
            |    
ClientFactory --+
                |
               ReconnectingClientFactory

Known Subclasses:
ReconnectingPBClientFactory, ReconnectingScanFactory

My clients auto-reconnect with an exponential back-off.

Note that clients should call my resetDelay method after they have connected successfully.
Method Summary
  clientConnectionFailed(self, connector, reason)
Called when a connection has failed to connect.
  clientConnectionLost(self, connector, unused_reason)
  resetDelay(self)
Call me after a successful connection to reset.
  retry(self, connector)
Have this connector connect again, after a suitable delay.
  stopTrying(self)
I put a stop to any attempt to reconnect in progress.
Inherited from ClientFactory: startedConnecting
Inherited from Factory: buildProtocol, doStart, doStop, startFactory, stopFactory

Instance Variable Summary
float factor: a multiplicitive factor by which the delay grows
float initialDelay: Delay for the first reconnection attempt.
float jitter: percentage of randomness to introduce into the delay length to prevent stampeding.
int maxDelay: Maximum number of seconds between connection attempts.

Class Variable Summary
NoneType connector = None                                                                  
int continueTrying = 1                                                                     
float delay = 1.0                                                                   
NoneType maxRetries = None                                                                  
int retries = 0                                                                     
Inherited from Factory: __implemented__, __providedBy__, __provides__, noisy, numPorts, protocol

Method Details

clientConnectionFailed(self, connector, reason)

Called when a connection has failed to connect.

It may be useful to call connector.connect() - this will reconnect.
Parameters:
reason
           (type=twisted.python.failure.Failure)
Overrides:
twisted.internet.protocol.ClientFactory.clientConnectionFailed (inherited documentation)

resetDelay(self)

Call me after a successful connection to reset.

I reset the delay and the retry counter.

retry(self, connector=None)

Have this connector connect again, after a suitable delay.

stopTrying(self)

I put a stop to any attempt to reconnect in progress.

Instance Variable Details

factor

a multiplicitive factor by which the delay grows
Type:
float
Value:
2.7182818284590451                                                    

initialDelay

Delay for the first reconnection attempt.
Type:
float
Value:
1.0                                                                   

jitter

percentage of randomness to introduce into the delay length to prevent stampeding.
Type:
float
Value:
0.11962656492                                                         

maxDelay

Maximum number of seconds between connection attempts.
Type:
int
Value:
3600                                                                  

Class Variable Details

connector

Type:
NoneType
Value:
None                                                                  

continueTrying

Type:
int
Value:
1                                                                     

delay

Type:
float
Value:
1.0                                                                   

maxRetries

Type:
NoneType
Value:
None                                                                  

retries

Type:
int
Value:
0                                                                     

   Trees       Index       Help   

Zenoss

Generated by Epydoc 2.1 on Thu Aug 16 09:55:10 2007 http://epydoc.sf.net