conference_state_exception
Module: Exceptions
The class that describes errors for attempted operations that require a different conference state.
#include <exception.h>
Inherits from dolbyio::comms::conference_exception, dolbyio::comms::exception, exception
Public Functions
Name | |
---|---|
const std::string & | required_state() const Returns the required state of a conference that is stored in the exception. |
const std::string & | current_state() const Returns the current state of a conference that is stored in the exception. |
conference_state_exception(const std::string & current, const std::string & required) The constructor that takes the current the required state. |
Additional inherited members
Public Functions inherited from dolbyio::comms::conference_exception
Name | |
---|---|
conference_exception(const std::string & description) The constructor that takes the exception description. |
Public Functions inherited from dolbyio::comms::exception
Name | |
---|---|
~exception() =default | |
const char * | what() const override Overrides to std::exception that returns a description of the exception. |
exception(const std::string & description) The constructor that takes the description of the exception. |
Protected Attributes inherited from dolbyio::comms::exception
Name | |
---|---|
std::string | fulldescription |
class dolbyio::comms::conference_state_exception;
Public Functions Documentation
function required_state
inline const std::string & required_state() const
Returns the required state of a conference that is stored in the exception.
Return: A string that contains the required state of a conference.
function current_state
inline const std::string & current_state() const
Returns the current state of a conference that is stored in the exception.
Return: The current session state.
function conference_state_exception
inline conference_state_exception(
const std::string & current,
const std::string & required
)
The constructor that takes the current the required state.
Parameters:
- current The current state of a conference.
- required The required state of a conference.
Updated 3 months ago