github/SleekXMPP
1
0
Fork 0
mirror of https://github.com/correl/SleekXMPP.git synced 2024-11-24 03:00:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

added block as process option and updated documentation. added typical use example to ClientXMPP.

Browse source
This commit is contained in:
Nathan Fritz 2011-08-04 21:49:32 -07:00
parent caec2976d7
commit 7f90de887a
3 changed files with 43 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
sleekxmpp/basexmpp.py
View file

@ -140,10 +140,28 @@ class BaseXMPP(XMLStream):
def process(self, *args, **kwargs): def process(self, *args, **kwargs):
""" """
Ensure that plugin inter-dependencies are handled before starting
event processing.
Overrides XMLStream.process. Overrides XMLStream.process.
Initialize the XML streams and begin processing events.
The number of threads used for processing stream events is determined
by HANDLER_THREADS.
Arguments:
block -- If block=False then event dispatcher will run
in a separate thread, allowing for the stream to be
used in the background for another application.
Otherwise, process(block=True) blocks the current thread.
Defaults to False.
**threaded is deprecated and included for API compatibility**
threaded -- If threaded=True then event dispatcher will run
in a separate thread, allowing for the stream to be
used in the background for another application.
Defaults to True.
Event handlers and the send queue will be threaded
regardless of these parameters.
""" """
for name in self.plugin: for name in self.plugin:
if not self.plugin[name].post_inited: if not self.plugin[name].post_inited:

7
sleekxmpp/clientxmpp.py
View file

@ -40,9 +40,12 @@ log = logging.getLogger(__name__)
class ClientXMPP(BaseXMPP): class ClientXMPP(BaseXMPP):
""" """
SleekXMPP's client class. SleekXMPP's client class. ( Use only for good, not for evil.)
Use only for good, not for evil. Typical Use:
xmpp = ClientXMPP('user@server.tld/resource', 'password')
xmpp.process(block=False) // when block is True, it blocks the current
// thread. False by default.
Attributes: Attributes:

20
sleekxmpp/xmlstream/xmlstream.py
View file

@ -831,7 +831,7 @@ class XMLStream(object):
self.send_queue.put(data) self.send_queue.put(data)
return True return True
def process(self, threaded=True): def process(self, **kwargs):
""" """
Initialize the XML streams and begin processing events. Initialize the XML streams and begin processing events.
@ -839,14 +839,28 @@ class XMLStream(object):
by HANDLER_THREADS. by HANDLER_THREADS.
Arguments: Arguments:
block -- If block=False then event dispatcher will run
in a separate thread, allowing for the stream to be
used in the background for another application.
Otherwise, process(block=True) blocks the current thread.
Defaults to False.
**threaded is deprecated and included for API compatibility**
threaded -- If threaded=True then event dispatcher will run threaded -- If threaded=True then event dispatcher will run
in a separate thread, allowing for the stream to be in a separate thread, allowing for the stream to be
used in the background for another application. used in the background for another application.
Defaults to True. Defaults to True.
Event handlers and the send queue will be threaded Event handlers and the send queue will be threaded
regardless of this parameter's value. regardless of these parameters.
""" """
if kwargs.has_key('threaded') and kwargs.has_key('block'):
raise ValueError("process() called with both block and threaded arguments")
elif kwargs.has_key('block'):
threaded = not(kwargs.get('block', False))
else:
threaded = kwargs.get('threaded', True)
self.scheduler.process(threaded=True) self.scheduler.process(threaded=True)
def start_thread(name, target): def start_thread(name, target):