gloox
1.0.28
|
#include <jingleplugin.h>
Public Member Functions | |
Plugin (JinglePluginType type) | |
virtual | ~Plugin () |
void | addPlugin (const Plugin *plugin) |
const Plugin * | findPlugin (int type) const |
template<class T > | |
const T * | findPlugin (int type) const |
const PluginList & | plugins () const |
virtual const StringList | features () const |
virtual const std::string & | filterString () const =0 |
virtual Tag * | tag () const =0 |
virtual Plugin * | newInstance (const Tag *tag) const =0 |
virtual Plugin * | clone () const =0 |
JinglePluginType | pluginType () const |
An abstraction of a Jingle plugin. This is part of Jingle (XEP-0166 et al.)
This is the base class for Content and all other pluggable Jingle-related containers, e.g. session information, such as the 'ringing' info in Jingle Audio, or Jingle DTMF, etc.
A Plugin abstracts the XML that gets sent and received as part of a Jingle session negotiation.
XEP Version: 1.1
Definition at line 67 of file jingleplugin.h.
|
inline |
Simple initializer.
Definition at line 76 of file jingleplugin.h.
|
inlinevirtual |
Virtual destructor.
Definition at line 81 of file jingleplugin.h.
|
inline |
Adds another Plugin as child.
plugin | A plugin to be embedded. Will be owned by this instance and deleted in the destructor. |
Definition at line 87 of file jingleplugin.h.
|
pure virtual |
Creates an identical deep copy of the current instance.
Implemented in Session::Reason, ICEUDP, FileTransfer, and Content.
|
inlinevirtual |
Reimplement this function if your plugin wants to add anything to the list of features announced via Disco.
Reimplemented in ICEUDP, and FileTransfer.
Definition at line 127 of file jingleplugin.h.
|
pure virtual |
Returns an XPath expression that describes a path to child elements of a jingle element that the plugin handles. The result should be a single Tag.
Implemented in Session::Reason, ICEUDP, FileTransfer, and Content.
|
inline |
Finds a Jingle::Plugin of a particular type.
type | JinglePluginType to search for. |
Definition at line 94 of file jingleplugin.h.
|
inline |
Finds a Jingle::Plugin of a particular type. Example:
type | The plugin type to look for. |
Definition at line 111 of file jingleplugin.h.
Returns a new instance of the same plugin type, based on the Tag provided.
tag | The Tag to parse and create a new instance from. |
Implemented in Session::Reason, ICEUDP, FileTransfer, and Content.
|
inline |
Returns a reference to a list of embedded plugins.
Definition at line 120 of file jingleplugin.h.
|
inline |
|
pure virtual |
Returns a Tag representation of the plugin.
Implemented in Session::Reason, ICEUDP, FileTransfer, and Content.