Package common :: Module jingle_session :: Class JingleSession

Class JingleSession

This represents one jingle session, that is, one or more content types negotiated between an initiator and a responder.

Instance Methods

__init__(self, con, weinitiate, jid, sid=None)
con -- connection object, weinitiate -- boolean, are we the initiator? jid - jid of the other entity

source code

approve_session(self)
Called when user accepts session in UI (when we aren't the initiator)

source code

decline_session(self)
Called when user declines session in UI (when we aren't the initiator)

source code

approve_content(self, media)

source code

reject_content(self, media)

source code

end_session(self)
Called when user stops or cancel session in UI

source code

get_content(self, media=None)

source code

add_content(self, name, content, creator='we')
Add new content to session.

source code

remove_content(self, creator, name, reason=None)
Remove the content name created by creator by sending content-remove, or by sending session-terminate if there is no content left. source code

modify_content(self, creator, name, *someother)
We do not need this now

source code

on_session_state_changed(self, content=None)

source code

is_ready(self)
Return True when all codecs and candidates are ready (for all contents)

source code

accept_session(self)
Mark the session as accepted

source code

start_session(self)
Mark the session as ready to be started

source code

send_session_info(self)

source code

send_content_accept(self, content)

source code

send_transport_info(self, content)

source code

send_description_info(self, content)

source code

on_stanza(self, stanza)
A callback for ConnectionJingle.

source code

__ack(self, stanza, jingle, error, action)
Default callback for action stanzas -- simple ack and stop processing

source code

__on_error(self, stanza, jingle, error, action)

source code

__on_transport_replace(self, stanza, jingle, error, action)

source code

__on_session_info(self, stanza, jingle, error, action)

source code

__on_content_remove(self, stanza, jingle, error, action)

source code

__on_session_accept(self, stanza, jingle, error, action)

source code

__on_content_accept(self, stanza, jingle, error, action)
Called when we get content-accept stanza or equivalent one (like session-accept)

source code

__on_content_add(self, stanza, jingle, error, action)

source code

__on_session_initiate(self, stanza, jingle, error, action)
We got a jingle session request from other entity, therefore we are the receiver...

source code

__broadcast(self, stanza, jingle, error, action)
Broadcast the stanza contents to proper content handlers

source code

__on_session_terminate(self, stanza, jingle, error, action)

source code

__broadcast_all(self, stanza, jingle, error, action)
Broadcast the stanza to all content handlers

source code

__parse_contents(self, jingle)

source code

__dispatch_error(self, error=None, text=None, type_=None)

source code

__reason_from_stanza(self, stanza)

source code

__make_jingle(self, action, reason=None)

source code

__send_error(self, stanza, error, jingle_error=None, text=None, type_=None)

source code

__append_content(self, jingle, content)
Append <content/> element to <jingle/> element, with (full=True) or without (full=False) <content/> children

source code

__append_contents(self, jingle)
Append all <content/> elements to <jingle/>

source code

__session_initiate(self)

source code

__session_accept(self)

source code

__session_info(self, payload=None)

source code

_session_terminate(self, reason=None)

source code

__content_add(self, content)

source code

__content_accept(self, content)

source code

__content_reject(self, content)

source code

__content_modify(self)

source code

__content_remove(self, content, reason=None)

source code

content_negotiated(self, media)

source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties

[hide private]

Inherited from object: __class__

Method Details

Class JingleSession

__init__(self, con, weinitiate, jid, sid=None) (Constructor)

approve_session(self)

decline_session(self)

approve_content(self, media)

reject_content(self, media)

end_session(self)

get_content(self, media=None)

add_content(self, name, content, creator='we')

remove_content(self, creator, name, reason=None)

modify_content(self, creator, name, *someother)

on_session_state_changed(self, content=None)

is_ready(self)

accept_session(self)

start_session(self)

send_session_info(self)

send_content_accept(self, content)

send_transport_info(self, content)

send_description_info(self, content)

on_stanza(self, stanza)

__ack(self, stanza, jingle, error, action)

__on_error(self, stanza, jingle, error, action)

__on_transport_replace(self, stanza, jingle, error, action)

__on_session_info(self, stanza, jingle, error, action)

__on_content_remove(self, stanza, jingle, error, action)

__on_session_accept(self, stanza, jingle, error, action)

__on_content_accept(self, stanza, jingle, error, action)

__on_content_add(self, stanza, jingle, error, action)

__on_session_initiate(self, stanza, jingle, error, action)

__broadcast(self, stanza, jingle, error, action)

__on_session_terminate(self, stanza, jingle, error, action)

__broadcast_all(self, stanza, jingle, error, action)

__parse_contents(self, jingle)

__dispatch_error(self, error=None, text=None, type_=None)

__reason_from_stanza(self, stanza)

__make_jingle(self, action, reason=None)

__send_error(self, stanza, error, jingle_error=None, text=None, type_=None)

__append_content(self, jingle, content)

__append_contents(self, jingle)

__session_initiate(self)

__session_accept(self)

__session_info(self, payload=None)

_session_terminate(self, reason=None)

__content_add(self, content)

__content_accept(self, content)

__content_reject(self, content)

__content_modify(self)

__content_remove(self, content, reason=None)

content_negotiated(self, media)

init(self, con, weinitiate, jid, sid=None)
(Constructor)