Base class for an XMPP-IM client.
This class does not provide any JSF extensions to the XMPP protocol,
including legacy authentication methods.
|
__init__(self,
jid=None,
password=None,
server=None,
port=5222,
auth_methods=( ' sasl:DIGEST-MD5 ' ) ,
tls_settings=None,
keepalive=0)
Initialize a Client object. |
source code
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
disconnect(self)
Disconnect from the server. |
source code
|
|
|
|
socket.socket
|
|
pyxmpp.ClientStream
|
|
|
idle(self)
Do some "housekeeping" work like cache expiration or timeout
handling. |
source code
|
|
|
|
|
request_roster(self)
Request the user's roster. |
source code
|
|
|
request_session(self)
Request an IM session. |
source code
|
|
|
|
|
|
|
|
|
|
|
|
|
|
: list of str
|
auth_methods
: methods allowed for stream authentication.
|
: list
|
interface_providers
: list of object providing interfaces that
could be used by the Client object.
|
: pyxmpp.JID
|
jid
: configured JID of the client (current actual JID
is avialable as self.stream.jid ).
|
: int
|
keepalive
: keepalive interval for the stream or 0 when keepalive is
disabled.
|
: threading.RLock
|
lock
: lock for synchronizing Client attributes access.
|
: unicode
|
password
: authentication password.
|
: int
|
port
: port number on the server to use if non-standard and not
discoverable by SRV lookups.
|
: pyxmpp.Roster
|
roster
: user's roster or None if the roster is not yet retrieved.
|
: unicode
|
server
: server to use if non-standard and not discoverable
by SRV lookups.
|
: bool
|
session_established
: True when an IM session is established.
|
: threading.Condition
|
state_changed
: condition notified the the object state changes
(stream becomes connected, session established etc.).
|
: pyxmpp.ClientStream
|
stream
: current stream when the client is connected,
None otherwise.
|