Session::Reason Class Reference

An abstraction of a terminate reason. More...

#include <jinglesession.h>

Inherits Plugin.

Inheritance diagram for Session::Reason:

[legend]List of all members.

Public Types
enum	Reasons {   AlternativeSession, Busy, Cancel, ConnectivityError,   Decline, Expired, GeneralError, Gone,   MediaError, SecurityError, Success, Timeout,   UnsupportedApplications, UnsupportedTransports, InvalidReason }
Public Member Functions
	Reason (Reasons reason, const std::string &sid=EmptyString, const std::string &text=EmptyString)
	Reason (const Tag *tag=0)
virtual	~Reason ()
Reasons	reason () const
const std::string &	sid () const
const std::string &	text () const
virtual const std::string &	filterString () const
virtual Tag *	tag () const
virtual Plugin *	clone () const

---

Detailed Description

An abstraction of a terminate reason.

XEP Version: 0.33

Author:

Jakob Schroeter <js@camaya.net>

Since:

1.1

Definition at line 105 of file jinglesession.h.

---

Member Enumeration Documentation

enum Reasons

Defied reasons for terminating a Jingle Session. Enumeration values: AlternativeSession  An alternative session exists that should be used. Busy  The terminating party is busy. Cancel  The session has been canceled. ConnectivityError  Connectivity error. Decline  The terminating party formally declines the request. Expired  The session has expired. GeneralError  General error. Gone  Participant went away. MediaError  Media error. SecurityError  Security error. Success  Session terminated after successful call. Timeout  A timeout occured. UnsupportedApplications  The terminating party does not support any of the offered application formats. UnsupportedTransports  The terminating party does not support any of the offered transport methods. InvalidReason  Invalid reason. Definition at line 111 of file jinglesession.h.

---

Constructor & Destructor Documentation

Reason (  Reasons  reason, const std::string &  sid = EmptyString, const std::string &  text = EmptyString )

Constructor. Parameters: reason  The reason for the termination of the session. sid  An optional session ID (only used if reason is AlternativeSession). text  An optional human-readable text explaining the reason for the session termination. Definition at line 77 of file jinglesession.cpp.

Reason (  const Tag *  tag = 0  )

Constructs a new element by parsing the given Tag. Parameters: tag  A tag to parse. Definition at line 84 of file jinglesession.cpp.

virtual ~Reason (   )  [inline, virtual]

Virtual destructor. Definition at line 148 of file jinglesession.h.

---

Member Function Documentation

Plugin * clone (   )  const [virtual]

Creates an identical deep copy of the current instance. Returns: An identical deep copy of the current instance. Implements Plugin. Definition at line 122 of file jinglesession.cpp.

const std::string & filterString (   )  const [virtual]

Returns an XPath expression that describes a path to child elements of a jingle element that a plugin handles. Returns: The plugin's filter string. Implements Plugin. Definition at line 100 of file jinglesession.cpp.

Reasons reason (   )  const [inline]

Returns the reason for the session termination. Returns: The reason for the session termination. Definition at line 154 of file jinglesession.h.

const std::string& sid (   )  const [inline]

Returns the session ID of the alternate session, if given (only applicable if reason() returns AlternativeSession). Returns: The session ID of the alternative session, or the empty string. Definition at line 161 of file jinglesession.h.

Tag * tag (   )  const [virtual]

Returns a Tag representation of the plugin. Returns: A Tag representation of the plugin. Implements Plugin. Definition at line 106 of file jinglesession.cpp.

const std::string& text (   )  const [inline]

Returns the content of an optional, human-readable <text> element. Returns: An optional text describing the reason for the action. Definition at line 168 of file jinglesession.h.

---

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

• jinglesession.h
• jinglesession.cpp

---