summaryrefslogtreecommitdiff
path: root/sleekxmpp/clientxmpp.py
diff options
context:
space:
mode:
Diffstat (limited to 'sleekxmpp/clientxmpp.py')
-rw-r--r--sleekxmpp/clientxmpp.py46
1 files changed, 40 insertions, 6 deletions
diff --git a/sleekxmpp/clientxmpp.py b/sleekxmpp/clientxmpp.py
index d5e985d2..dc08522d 100644
--- a/sleekxmpp/clientxmpp.py
+++ b/sleekxmpp/clientxmpp.py
@@ -246,7 +246,8 @@ class ClientXMPP(BaseXMPP):
p = self._sasl_mechanism_priorities
self._sasl_mechanism_priorities = [i for i in p if i[1] != name]
- def update_roster(self, jid, name=None, subscription=None, groups=[]):
+ def update_roster(self, jid, name=None, subscription=None, groups=[],
+ block=True, timeout=None, callback=None):
"""
Add or change a roster item.
@@ -257,13 +258,24 @@ class ClientXMPP(BaseXMPP):
'to', 'from', 'both', or 'none'. If set
to 'remove', the entry will be deleted.
groups -- The roster groups that contain this item.
+ block -- Specify if the roster request will block
+ until a response is received, or a timeout
+ occurs. Defaults to True.
+ timeout -- The length of time (in seconds) to wait
+ for a response before continuing if blocking
+ is used. Defaults to self.response_timeout.
+ callback -- Optional reference to a stream handler function.
+ Will be executed when the roster is received.
+ Implies block=False.
"""
iq = self.Iq()
iq['type'] = 'set'
iq['roster']['items'] = {jid: {'name': name,
'subscription': subscription,
'groups': groups}}
- response = iq.send()
+ response = iq.send(block, timeout, callback)
+ if response in [False, None]:
+ return response
return response['type'] == 'result'
def del_roster_item(self, jid):
@@ -276,13 +288,33 @@ class ClientXMPP(BaseXMPP):
"""
return self.update_roster(jid, subscription='remove')
- def get_roster(self):
- """Request the roster from the server."""
+ def get_roster(self, block=True, timeout=None, callback=None):
+ """
+ Request the roster from the server.
+
+ Arguments:
+ block -- Specify if the roster request will block until a
+ response is received, or a timeout occurs.
+ Defaults to True.
+ timeout -- The length of time (in seconds) to wait for a response
+ before continuing if blocking is used.
+ Defaults to self.response_timeout.
+ callback -- Optional reference to a stream handler function. Will
+ be executed when the roster is received.
+ Implies block=False.
+ """
iq = self.Iq()
iq['type'] = 'get'
iq.enable('roster')
- response = iq.send()
- self._handle_roster(response, request=True)
+ response = iq.send(block, timeout, callback)
+
+ if response == False:
+ self.event('roster_timeout')
+
+ if response in [False, None] or not isinstance(response, Iq):
+ return response
+ else:
+ return self._handle_roster(response, request=True)
def _handle_connected(self, event=None):
#TODO: Use stream state here
@@ -495,12 +527,14 @@ class ClientXMPP(BaseXMPP):
'presence': {},
'in_roster': True}
self.roster[jid].update(iq['roster']['items'][jid])
+ self.event('roster_received', iq)
self.event("roster_update", iq)
if iq['type'] == 'set':
iq.reply()
iq.enable('roster')
iq.send()
+ return True
# To comply with PEP8, method names now use underscores.