Session Class Reference

This is an implementation of a Jingle Session (XEP-0166). More...

#include <jinglesession.h>

Inherits IqHandler.

Inheritance diagram for Session:

[legend]List of all members.

Public Types
enum	State
Public Member Functions
virtual	~Session ()
void	addContent (Content *content)
virtual bool	handleIq (const IQ &iq)
virtual void	handleIqID (const IQ &iq, int context)
Classes
class	Jingle
	This is an implementation of XEP-0166 (Jingle) as a StanzaExtension. More...

---

Detailed Description

This is an implementation of a Jingle Session (XEP-0166).

Beware! The classes in the Jingle namespace implement the signaling part of Jingle only. At this point, there is no support for actually establishing any connection to a remote entity, nor for transfering any media in any way whatsoever.

XEP Version: 0.25

Author:

Jakob Schroeter <js@camaya.net>

Since:

1.0

Definition at line 76 of file jinglesession.h.

---

Member Enumeration Documentation

enum State

Session state. Definition at line 83 of file jinglesession.h.

---

Constructor & Destructor Documentation

~Session (   )  [virtual]

Virtual Destructor. Definition at line 105 of file jinglesession.cpp.

---

Member Function Documentation

void addContent (  Content *  content  )  [inline]

Use this function to add a new Jingle Content Type to this Session. A Content Type consists of a Description (Application Format), e.g. AudioRTP, and a Transport, e.g. ICEUDP. This enables the Session to offer that Content Type to the peer. Parameters: content  A ContentType to add. Definition at line 207 of file jinglesession.h.

bool handleIq (  const IQ &  iq  )  [virtual]

Reimplement this function if you want to be notified about incoming IQs. Parameters: iq  The complete IQ stanza. Returns: Indicates whether a request of type 'get' or 'set' has been handled. This includes the obligatory 'result' answer. If you return false, a 'error' will be sent. Since: 1.0 Implements IqHandler. Definition at line 154 of file jinglesession.cpp.

void handleIqID (  const IQ &  iq, int  context )  [virtual]

Reimplement this function if you want to be notified about incoming IQs with a specific value of the id attribute. You have to enable tracking of those IDs using Client::trackID(). This is usually useful for IDs that generate a positive reply, i.e. <iq type='result' id='reg'/> where a namespace filter wouldn't work. Parameters: iq  The complete IQ stanza. context  A value to restore context, stored with ClientBase::trackID(). Note: Only IQ stanzas of type 'result' or 'error' can arrive here. Since: 1.0 Implements IqHandler. Definition at line 169 of file jinglesession.cpp.

---

The documentation for this class was generated from the following files:

• jinglesession.h
• jinglesession.cpp

---