class JGSession0

The version 0 of a jingle session. More...

Full nameTelEngine::JGSession0
Definition#include <libs/yjabber/yatejingle.h>
InheritsTelEngine::JGSession [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods

Protected Members


Detailed Description

A session implementing the old jingle protocol

 ~JGSession0 ()

~JGSession0

[virtual]

Destructor

bool  accept (const ObjList& contents, String* stanzaId = 0)

accept

[virtual]

Accept a Pending incoming session. This method is thread safe

Parameters:
contentsThe list of accepted contents
stanzaIdOptional string to be filled with sent stanza id (used to track the response)

Returns: False if send failed

Reimplemented from JGSession.

 JGSession0 (JGEngine* engine, const JabberID& caller, const JabberID& called)

JGSession0

[protected]

Constructor. Create an outgoing session

Parameters:
engineThe engine owning this session
callerThe caller's full JID
calledThe called party's full JID

 JGSession0 (JGEngine* engine, const JabberID& caller, const JabberID& called, XmlElement* xml, const String& id)

JGSession0

[protected]

Constructor. Create an incoming session.

Parameters:
engineThe engine owning this session
callerThe caller's full JID
calledThe called party's full JID
xmlA valid Jabber Jingle xml with action session initiate
idSession id

bool  initiate (const ObjList& contents, XmlElement* extra, const char* subject = 0)

initiate

[protected virtual]

Build and send the initial message on an outgoing session

Parameters:
contentsThe session contents to be sent with session initiate element
extraOptional extra child to be added to the session initiate element
subjectOptional session subject

Returns: True on success

Reimplemented from JGSession.

bool  sendContent (Action action, const ObjList& contents, String* stanzaId = 0)

sendContent

[protected virtual]

Send a stanza with session content(s) This method is thread safe

Parameters:
actionMust be a transport- action
contentsNon empty list with content(s) to send
stanzaIdOptional string to be filled with sent stanza id (used to track the response)

Returns: False if send failed

Reimplemented from JGSession.

JGEvent*  decodeJingle (XmlElement*& xml, XmlElement* child)

decodeJingle

[protected virtual]

Decode a jingle element

Parameters:
xmlThe element to decode
childThe element's first child

Returns: JGEvent pointer or 0

Reimplemented from JGSession.

XmlElement*  createJingle (Action action, XmlElement* element1 = 0, XmlElement* element2 = 0, XmlElement* element3 = 0)

createJingle

[protected virtual]

Create an 'iq' of type 'set' with a 'jingle' child

Parameters:
actionThe action of the Jingle stanza
element1Optional child element
element2Optional child element
element3Optional child element

Returns: Valid XmlElement pointer

Reimplemented from JGSession.

XmlElement*  createDtmf (const char* dtmf, unsigned int msDuration = 0)

createDtmf

[protected virtual]

Create a dtmf XML element

Parameters:
dtmfThe dtmf string
msDurationThe tone duration in miliseconds. Ignored if 0

Returns: Valid XmlElement pointer or 0

Reimplemented from JGSession.

String m_sessContentName

m_sessContentName

[protected]

Action m_candidatesAction

m_candidatesAction

[protected]


Generated by: paulc on bussard on Fri Apr 1 18:17:10 2011, using kdoc 2.0a54.