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

Add parameter docs for add_filter.

Browse source
This commit is contained in:
Lance Stout 2011-12-12 22:37:19 -08:00
parent eff3330e75
commit cb635dcd5a
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
sleekxmpp/xmlstream/xmlstream.py
View file

@ -750,6 +750,16 @@ class XMLStream(object):
These filters are applied before incoming stanzas are These filters are applied before incoming stanzas are
passed to any handlers, and before outgoing stanzas passed to any handlers, and before outgoing stanzas
are put in the send queue. are put in the send queue.
Each filter must accept a single stanza, and return
either a stanza or ``None``. If the filter returns
``None``, then the stanza will be dropped from being
processed for events or from being sent.
:param mode: One of ``'in'`` or ``'out'``.
:param handler: The filter function.
:param int order: The position to insert the filter in
the list of active filters.
""" """
if order: if order:
self.__filters[mode].insert(order, handler) self.__filters[mode].insert(order, handler)