Home | Trees | Index | Help |
|
---|
|
Client
--+
|
JabberClient
Method Summary | |
---|---|
Initialize a JabberClient object. | |
Handle "authorized" event. | |
Connect to the server and set up the stream. | |
DiscoInfo |
Return Disco#info data for a node. |
DiscoInfo |
Return Disco#items data for a node. |
Fill-in the registration form provided by the server. | |
Register a feature to be announced by Service Discovery. | |
Submit a registration form | |
Unregister a feature to be announced by Service Discovery. | |
Inherited from Client | |
Handle "authenticated" event. | |
Handle "connected" event. | |
Disconnect from the server. | |
Handle "disconnected" event. | |
socket.socket |
Get the socket object of the active connection. |
pyxmpp.ClientStream |
Get the connected stream object. |
Do some "housekeeping" work like cache expiration or timeout handling. | |
Simple "main loop" for the client. | |
Request the user's roster. | |
Request an IM session. | |
Handle roster update event. | |
Handle session started event. | |
Handle stream closure event. | |
Handle stream creation event. | |
Handle stream error received. | |
Handle any stream state change. |
Instance Variable Summary | |
---|---|
disco_identity : default identity of the default disco_info . | |
DiscoInfo |
disco_info : default Disco#info reply for a query to an empty node --
provides information about the client and its supported fetures. |
DiscoItems |
disco_items : default Disco#items reply for a query to an empty node. |
bool |
register : when True than registration will be started instead of authentication. |
Inherited from Client | |
list of str |
auth_methods : methods allowed for stream authentication. |
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. |
Method Details |
---|
__init__(self,
jid=None,
password=None,
server=None,
port=5222,
auth_methods=('sasl:DIGEST-MD5', 'digest'),
tls_settings=None,
keepalive=0,
disco_name=u'pyxmpp based Jabber client',
disco_category=u'client',
disco_type=u'pc')
Initialize a JabberClient object. |
authorized(self)Handle "authorized" event. May be overriden in derived classes. By default: request an IM session and setup Disco handlers.
|
connect(self, register=False)Connect to the server and set up the stream. Set
|
disco_get_info(self, node, iq)Return Disco#info data for a node.
|
disco_get_items(self, node, iq)Return Disco#items data for a node.
|
process_registration_form(self, stanza, form)Fill-in the registration form provided by the server. This default implementation fills-in "username" and "passwords" fields only and instantly submits the form.
|
register_feature(self, feature_name)Register a feature to be announced by Service Discovery.
|
submit_registration_form(self, form)Submit a registration form
|
unregister_feature(self, feature_name)Unregister a feature to be announced by Service Discovery.
|
Instance Variable Details |
---|
disco_identitydefault identity of the defaultdisco_info . |
disco_infodefault Disco#info reply for a query to an empty node -- provides information about the client and its supported fetures.
|
disco_itemsdefault Disco#items reply for a query to an empty node.
|
registerwhenTrue than registration will be started instead of authentication.
|
Home | Trees | Index | Help |
|
---|
Generated by Epydoc 2.1 on Mon Dec 26 17:57:43 2005 | http://epydoc.sf.net |