Package common :: Module connection :: Class CommonConnection

[frames] | no frames]

Class CommonConnection

Common connection class, can be derivated for normal connection or zeroconf connection

Instance Methods

__init__(self, name)

source code

_compute_resource(self)

source code

dispatch(self, event, data)
Always passes account name as first param

source code

_reconnect(self)
To be implemented by derivated classes

source code

quit(self, kill_core)

source code

test_gpg_passphrase(self, password)
Returns 'ok', 'bad_pass' or 'expired'

source code

get_signed_msg(self, msg, callback=None)
Returns the signed message if possible or an empty string if gpg is not used or None if waiting for passphrase

source code

_on_disconnected(self)
Called when a disconnect request has completed successfully

source code

get_status(self)

source code

check_jid(self, jid)
This function must be implemented by derivated classes.

source code

_prepare_message(self, jid, msg, keyID, type_='chat', subject='', chatstate=None, msg_id=None, composing_xep=None, resource=None, user_nick=None, xhtml=None, session=None, forward_from=None, form_node=None, label=None, original_message=None, delayed=None, callback=None)

source code

_message_encrypted_cb(self, output, type_, msg, msgtxt, original_message, fjid, resource, jid, xhtml, subject, chatstate, msg_id, composing_xep, label, forward_from, delayed, session, form_node, user_nick, keyID, callback)

source code

_on_continue_message(self, type_, msg, msgtxt, original_message, fjid, resource, jid, xhtml, subject, msgenc, keyID, chatstate, msg_id, composing_xep, label, forward_from, delayed, session, form_node, user_nick, callback)

source code

log_message(self, jid, msg, forward_from, session, original_message, subject, type_)

source code

ack_subscribed(self, jid)
To be implemented by derivated classes

source code

ack_unsubscribed(self, jid)
To be implemented by derivated classes

source code

request_subscription(self, jid, msg='', name='', groups=[], auto_auth=False)
To be implemented by derivated classes

source code

send_authorization(self, jid)
To be implemented by derivated classes

source code

refuse_authorization(self, jid)
To be implemented by derivated classes

source code

unsubscribe(self, jid, remove_auth=True)
To be implemented by derivated classes

source code

unsubscribe_agent(self, agent)
To be implemented by derivated classes

source code

update_contact(self, jid, name, groups)

source code

update_contacts(self, contacts)
Update multiple roster items

source code

new_account(self, name, config, sync=False)
To be implemented by derivated classes

source code

_on_new_account(self, con=None, con_type=None)
To be implemented by derivated classes

source code

account_changed(self, new_name)

source code

request_last_status_time(self, jid, resource, groupchat_jid=None)
groupchat_jid is used when we want to send a request to a real jid and act as if the answer comes from the groupchat_jid

source code

request_os_info(self, jid, resource)
To be implemented by derivated classes

source code

get_settings(self)
To be implemented by derivated classes

source code

get_bookmarks(self)
To be implemented by derivated classes

source code

store_bookmarks(self)
To be implemented by derivated classes

source code

get_metacontacts(self)
To be implemented by derivated classes

source code

send_agent_status(self, agent, ptype)
To be implemented by derivated classes

source code

gpg_passphrase(self, passphrase)

source code

ask_gpg_keys(self)

source code

ask_gpg_secrete_keys(self)

source code

load_roster_from_db(self)

source code

_event_dispatcher(self, realm, event, data)

source code

change_status(self, show, msg, auto=False)

source code

Method Details

init(self, name)
(Constructor)

_compute_resource(self)

dispatch(self, event, data)

Always passes account name as first param

_reconnect(self)

To be implemented by derivated classes

quit(self, kill_core)

test_gpg_passphrase(self, password)

Returns 'ok', 'bad_pass' or 'expired'

get_signed_msg(self, msg, callback=None)

Returns the signed message if possible or an empty string if gpg is not used or None if waiting for passphrase

callback is the function to call when user give the passphrase

_on_disconnected(self)

Called when a disconnect request has completed successfully

get_status(self)

check_jid(self, jid)

This function must be implemented by derivated classes. It has to return the valid jid, or raise a helpers.InvalidFormat exception

_prepare_message(self, jid, msg, keyID, type_='chat', subject='', chatstate=None, msg_id=None, composing_xep=None, resource=None, user_nick=None, xhtml=None, session=None, forward_from=None, form_node=None, label=None, original_message=None, delayed=None, callback=None)

_message_encrypted_cb(self, output, type_, msg, msgtxt, original_message, fjid, resource, jid, xhtml, subject, chatstate, msg_id, composing_xep, label, forward_from, delayed, session, form_node, user_nick, keyID, callback)

_on_continue_message(self, type_, msg, msgtxt, original_message, fjid, resource, jid, xhtml, subject, msgenc, keyID, chatstate, msg_id, composing_xep, label, forward_from, delayed, session, form_node, user_nick, callback)

log_message(self, jid, msg, forward_from, session, original_message, subject, type_)

ack_subscribed(self, jid)

To be implemented by derivated classes

ack_unsubscribed(self, jid)

To be implemented by derivated classes

request_subscription(self, jid, msg='', name='', groups=[], auto_auth=False)

To be implemented by derivated classes

send_authorization(self, jid)

To be implemented by derivated classes

refuse_authorization(self, jid)

To be implemented by derivated classes

unsubscribe(self, jid, remove_auth=True)

To be implemented by derivated classes

unsubscribe_agent(self, agent)

To be implemented by derivated classes

update_contact(self, jid, name, groups)

update_contacts(self, contacts)

Update multiple roster items

new_account(self, name, config, sync=False)

To be implemented by derivated classes

_on_new_account(self, con=None, con_type=None)

To be implemented by derivated classes

account_changed(self, new_name)

request_last_status_time(self, jid, resource, groupchat_jid=None)

groupchat_jid is used when we want to send a request to a real jid and act as if the answer comes from the groupchat_jid

request_os_info(self, jid, resource)

To be implemented by derivated classes

get_settings(self)

To be implemented by derivated classes

get_bookmarks(self)

To be implemented by derivated classes

store_bookmarks(self)

To be implemented by derivated classes

get_metacontacts(self)

To be implemented by derivated classes

send_agent_status(self, agent, ptype)

To be implemented by derivated classes

gpg_passphrase(self, passphrase)

ask_gpg_keys(self)

ask_gpg_secrete_keys(self)

load_roster_from_db(self)

_event_dispatcher(self, realm, event, data)

change_status(self, show, msg, auto=False)