#include <yatejingle.h>
Public Types | |
enum | Type { Jingle, Terminated, Destroy } |
Public Member Functions | |
virtual | ~JGEvent () |
Type | type () const |
JGSession * | session () const |
XMLElement * | element () const |
JGSession::Action | action () const |
JGAudioList & | audio () |
ObjList & | transport () |
const String & | id () const |
const String & | reason () const |
const String & | text () const |
XMLElement * | releaseXML () |
bool | final () const |
Protected Member Functions | |
JGEvent (Type type, JGSession *session, XMLElement *element=0, const char *reason=0, const char *text=0) | |
JGEvent (JGSession::Action act, JGSession *session, XMLElement *element, const char *reason=0, const char *text=0) | |
Friends | |
class | JGSession |
This class holds an event generated by a Jingle session
enum Type |
Jingle events enumeration
virtual ~JGEvent | ( | ) | [virtual] |
Destructor. Deref the session. Delete the XML element
JGEvent | ( | Type | type, | |
JGSession * | session, | |||
XMLElement * | element = 0 , |
|||
const char * | reason = 0 , |
|||
const char * | text = 0 | |||
) | [inline, protected] |
Constructor. Set the id parameter if the element is valid
type | Event type | |
session | The session that generated this event | |
element | Optional XML element that generated this event | |
reason | Optional reason data | |
text | Optional text data |
JGEvent | ( | JGSession::Action | act, | |
JGSession * | session, | |||
XMLElement * | element, | |||
const char * | reason = 0 , |
|||
const char * | text = 0 | |||
) | [inline, protected] |
Constructor. Create a Jingle event. Set the id parameter if the element is valid
act | The jingle action | |
session | The session that generated this event | |
element | XML element that generated this event | |
reason | Optional reason data | |
text | Optional text data |
JGSession::Action action | ( | ) | const [inline] |
Get the jingle action as enumeration
JGAudioList& audio | ( | ) | [inline] |
Get the audio payloads list
XMLElement* element | ( | ) | const [inline] |
Get the XML element that generated this event
bool final | ( | ) | const [inline] |
Check if this event is a final one (Terminated or Destroy)
const String& id | ( | ) | const [inline] |
Get the id
const String& reason | ( | ) | const [inline] |
Get the reason
XMLElement* releaseXML | ( | ) | [inline] |
Get the XML element that generated this event and set it to 0
JGSession* session | ( | ) | const [inline] |
Get the session that generated this event
const String& text | ( | ) | const [inline] |
Get the text
ObjList& transport | ( | ) | [inline] |
Get the transports list
Type type | ( | ) | const [inline] |
Get the type of this event