From 9e2cada19eb9704bebadf6e4d382bda5d42015c9 Mon Sep 17 00:00:00 2001 From: Lance Stout Date: Wed, 6 Oct 2010 14:09:14 -0400 Subject: [PATCH] Missed a few docstrings. --- sleekxmpp/__init__.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/sleekxmpp/__init__.py b/sleekxmpp/__init__.py index 26982a54..023292ba 100644 --- a/sleekxmpp/__init__.py +++ b/sleekxmpp/__init__.py @@ -239,6 +239,12 @@ class ClientXMPP(BaseXMPP): return True def _handle_starttls(self, xml): + """ + Handle notification that the server supports TLS. + + Arguments: + xml -- The STARTLS proceed element. + """ if not self.authenticated and self.ssl_support: tls_ns = 'urn:ietf:params:xml:ns:xmpp-tls' self.add_handler("" % tls_ns, @@ -253,11 +259,22 @@ class ClientXMPP(BaseXMPP): return False def _handle_tls_start(self, xml): + """ + Handle encrypting the stream using TLS. + + Restarts the stream. + """ logging.debug("Starting TLS") if self.start_tls(): raise RestartStream() def _handle_sasl_auth(self, xml): + """ + Handle authenticating using SASL. + + Arguments: + xml -- The SASL mechanisms stanza. + """ if '{urn:ietf:params:xml:ns:xmpp-tls}starttls' in self.features: return False