|
# This file is part of Buildbot. Buildbot is free software: you can # redistribute it and/or modify it under the terms of the GNU General Public # License as published by the Free Software Foundation, version 2. # # This program is distributed in the hope that it will be useful, but WITHOUT # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more # details. # # You should have received a copy of the GNU General Public License along with # this program; if not, write to the Free Software Foundation, Inc., 51 # Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # # Copyright Buildbot Team Members
"""
protocol.ReconnectingClientFactory): """Reconnecting client factory for PB brokers.
Like PBClientFactory, but if the connection fails or is lost, the factory will attempt to reconnect.
Instead of using f.getRootObject (which gives a Deferred that can only be fired once), override the gotRootObject method.
Instead of using the newcred f.login (which is also one-shot), call f.startLogin() with the credentials and client, and override the gotPerspective method.
gotRootObject and gotPerspective will be called each time the object is received (once per successful connection attempt). You will probably want to use obj.notifyOnDisconnect to find out when the connection is lost.
If an authorization error occurs, failedToGetPerspective() will be invoked.
To use me, subclass, then hand an instance to a connector (like TCPClient). """
# hung connections wait for a relatively long time, since a busy master may # take a while to get back to us.
PBClientFactory.clientConnectionFailed(self, connector, reason) if self.continueTrying: self.connector = connector self.retry()
reconnecting=True)
# newcred methods
raise RuntimeError, "login is one-shot: use startLogin instead"
# newcred login() self._credentials.password, self._client) errbackArgs=(broker,))
# timer for hung connections
log.msg("connection attempt timed out (is the port number correct?)") self.hungConnectionTimer = None connector.disconnect() # (this will trigger the retry)
# methods to override
"""The remote avatar or perspective (obtained each time this factory connects) is now available."""
"""The remote root object (obtained each time this factory connects) is now available. This method will be called each time the connection is established and the object reference is retrieved."""
"""The login process failed, most likely because of an authorization failure (bad password), but it is also possible that we lost the new connection before we managed to send our credentials. """ # put something useful in the logs # fall through elif why.check(error.UnauthorizedLogin): log.msg("unauthorized login; check slave name and password") # fall through else: log.err(why, 'While trying to connect:') self.stopTrying() reactor.stop() return
# lose the current connection, which will trigger a retry |