JGEvent Class Reference

A Jingle event. More...

#include <yatejingle.h>

List of all members.

Public Types

enum  Type { Jingle, Terminated, Destroy }

Public Member Functions

virtual ~JGEvent ()
Type type () const
JGSessionsession () const
XMLElementelement () const
JGSession::Action action () const
JGAudioListaudio ()
ObjListtransport ()
const Stringid () const
const Stringreason () const
const Stringtext () const
XMLElementreleaseXML ()
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


Detailed Description

A Jingle event.

This class holds an event generated by a Jingle session


Member Enumeration Documentation

enum Type

Jingle events enumeration


Constructor & Destructor Documentation

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

Parameters:
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

Parameters:
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


Member Function Documentation

Type type (  )  const [inline]

Get the type of this event

Returns:
The type of this event as enumeration

JGSession* session (  )  const [inline]

Get the session that generated this event

Returns:
The session that generated this event

XMLElement* element (  )  const [inline]

Get the XML element that generated this event

Returns:
The XML element that generated this event

JGSession::Action action (  )  const [inline]

Get the jingle action as enumeration

Returns:
The jingle action as enumeration

JGAudioList& audio (  )  [inline]

Get the audio payloads list

Returns:
The audio payloads list

ObjList& transport (  )  [inline]

Get the transports list

Returns:
The transports list

const String& id (  )  const [inline]

Get the id

Returns:
The id

const String& reason (  )  const [inline]

Get the reason

Returns:
The reason

const String& text (  )  const [inline]

Get the text

Returns:
The text

XMLElement* releaseXML (  )  [inline]

Get the XML element that generated this event and set it to 0

Returns:
The XML element that generated this event

bool final (  )  const [inline]

Check if this event is a final one (Terminated or Destroy)

Returns:
True if it is


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

Generated on Mon Aug 11 16:17:54 2008 for Yate by  doxygen 1.5.6