session_state_exception

Module: Exceptions

The class that defines exceptions for invalid session states.

#include <exception.h>

Public Functions

	Name
	session_state_exception(const std::string & current, const std::string & required) The constructor that takes the current and the required state of a session.
const std::string &	required_state() const Returns the required state of a session that is stored in the exception.
const std::string &	current_state() const Returns the current state of a session that is stored in the exception.

Public Functions inherited from dolbyio::comms::session_exception

	Name
	session_exception(const std::string & description) The constructor that takes the error 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::session_state_exception;

inline session_state_exception(
    const std::string & current,
    const std::string & required
)

The constructor that takes the current and the required state of a session.

Parameters:

inline const std::string & required_state() const

Returns the required state of a session that is stored in the exception.

Return: A string that contains the required state of a session.

inline const std::string & current_state() const

Returns the current state of a session that is stored in the exception.

Return: The current state of the session.