gloox  1.0.9
Public Member Functions | List of all members
Session::Jingle Class Reference

#include <jinglesession.h>

Inheritance diagram for Session::Jingle:
Inheritance graph
[legend]

Public Member Functions

 Jingle (const Tag *tag=0)
virtual ~Jingle ()
const std::string & sid () const
void setInitiator (const JID &jid)
const JIDinitiator () const
void setResponder (const JID &jid)
Action action () const
void addPlugin (const Plugin *plugin)
const PluginListplugins () const
TagembeddedTag () const
virtual const std::string & filterString () const
virtual StanzaExtensionnewInstance (const Tag *tag) const
virtual Tagtag () const
virtual StanzaExtensionclone () const
- Public Member Functions inherited from StanzaExtension
 StanzaExtension (int type)
virtual ~StanzaExtension ()
virtual StanzaembeddedStanza () const
int extensionType () const

Detailed Description

This is an abstraction of Jingle's (XEP-0166) <jingle> element as a StanzaExtension.

XEP Version: 1.1

Author
Jakob Schroeter js@ca.nosp@m.maya.nosp@m..net
Since
1.0.5

Definition at line 198 of file jinglesession.h.

Constructor & Destructor Documentation

Jingle ( const Tag tag = 0)

Constructs a new object from the given Tag.

Parameters
tagThe Tag to parse.

Definition at line 146 of file jinglesession.cpp.

~Jingle ( )
virtual

Virtual Destructor.

Definition at line 179 of file jinglesession.cpp.

Member Function Documentation

Action action ( ) const
inline

Returns this Jingle's action.

Returns
The action.

Definition at line 243 of file jinglesession.h.

void addPlugin ( const Plugin plugin)
inline

Adds a Plugin as child.

Parameters
pluginA plugin to be embedded. Will be owned by this instance and deleted in the destructor.

Definition at line 249 of file jinglesession.h.

StanzaExtension * clone ( ) const
virtual

Returns an identical copy of the current StanzaExtension.

Returns
An identical copy of the current StanzaExtension.

Implements StanzaExtension.

Definition at line 214 of file jinglesession.cpp.

Tag* embeddedTag ( ) const
inlinevirtual

Returns the tag to build plugins from.

Returns
The tag to build plugins from.

Reimplemented from StanzaExtension.

Definition at line 261 of file jinglesession.h.

const std::string & filterString ( ) const
virtual

Returns an XPath expression that describes a path to child elements of a stanza that an extension handles.

Returns
The extension's filter string.

Implements StanzaExtension.

Definition at line 184 of file jinglesession.cpp.

const JID& initiator ( ) const
inline

Returns the initiator.

Returns
The initiator.

Definition at line 231 of file jinglesession.h.

virtual StanzaExtension* newInstance ( const Tag tag) const
inlinevirtual

Returns a new Instance of the derived type. Usually, for a derived class FooExtension, the implementation of this function looks like:

{
return new FooExtension( tag );
}
Returns
The derived extension's new instance.

Implements StanzaExtension.

Definition at line 267 of file jinglesession.h.

const PluginList& plugins ( ) const
inline

Returns a reference to a list of embedded plugins.

Returns
A reference to a list of embedded plugins.

Definition at line 255 of file jinglesession.h.

void setInitiator ( const JID jid)
inline

Set's the session's initiator.

Parameters
jidThe session initiator's JID.

Definition at line 225 of file jinglesession.h.

void setResponder ( const JID jid)
inline

Set's the session's responder.

Parameters
jidThe session responder's JID.

Definition at line 237 of file jinglesession.h.

const std::string& sid ( ) const
inline

Returns the session ID.

Returns
The session ID.

Definition at line 219 of file jinglesession.h.

Tag * tag ( ) const
virtual

Returns a Tag representation of the extension.

Returns
A Tag representation of the extension.

Implements StanzaExtension.

Definition at line 190 of file jinglesession.cpp.


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