summaryrefslogtreecommitdiff
path: root/sleekxmpp/clientxmpp.py
diff options
context:
space:
mode:
authorNathan Fritz <fritzy@netflint.net>2011-08-04 21:49:32 -0700
committerNathan Fritz <fritzy@netflint.net>2011-08-04 21:49:32 -0700
commit7f90de887a7e3ca53103babf5a9acf15a69ab959 (patch)
tree2cffbf7669ffc6889510db60b3961ac238f7ed4b /sleekxmpp/clientxmpp.py
parentcaec2976d7788dba75a82dfb9079b57c96ef7b47 (diff)
downloadslixmpp-7f90de887a7e3ca53103babf5a9acf15a69ab959.tar.gz
slixmpp-7f90de887a7e3ca53103babf5a9acf15a69ab959.tar.bz2
slixmpp-7f90de887a7e3ca53103babf5a9acf15a69ab959.tar.xz
slixmpp-7f90de887a7e3ca53103babf5a9acf15a69ab959.zip
added block as process option and updated documentation. added typical use example to ClientXMPP.
Diffstat (limited to 'sleekxmpp/clientxmpp.py')
-rw-r--r--sleekxmpp/clientxmpp.py7
1 files changed, 5 insertions, 2 deletions
diff --git a/sleekxmpp/clientxmpp.py b/sleekxmpp/clientxmpp.py
index 95ae108b..ad127726 100644
--- a/sleekxmpp/clientxmpp.py
+++ b/sleekxmpp/clientxmpp.py
@@ -40,9 +40,12 @@ log = logging.getLogger(__name__)
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: