opentera::SignalingServerConfiguration Class Reference

Represents a signaling server configuration. More...

#include <SignalingServerConfiguration.h>

Public Member Functions
	SignalingServerConfiguration (const SignalingServerConfiguration &other)=default
	SignalingServerConfiguration (SignalingServerConfiguration &&other)=default
const std::string &	url () const
	Returns the signaling server URL. More...
const std::string &	clientName () const
	Returns the client name. More...
const nlohmann::json &	clientData () const
	Returns the client data. More...
const std::string &	room () const
	Returns the room name. More...
const std::string &	password () const
	Returns the signaling server password. More...
SignalingServerConfiguration &	operator= (const SignalingServerConfiguration &other)=default
SignalingServerConfiguration &	operator= (SignalingServerConfiguration &&other)=default

Static Public Member Functions
static SignalingServerConfiguration	create (std::string url, std::string clientName, std::string room)
	Creates an signaling server configuration with the specified values. More...
static SignalingServerConfiguration	createWithData (std::string url, std::string clientName, nlohmann::json clientData, std::string room)
	Creates an signaling server configuration with the specified values. More...
static SignalingServerConfiguration	create (std::string url, std::string clientName, std::string room, std::string password)
	Creates an signaling server configuration with the specified values. More...
static SignalingServerConfiguration	createWithData (std::string url, std::string clientName, nlohmann::json clientData, std::string room, std::string password)
	Creates an signaling server configuration with the specified values. More...

Detailed Description

Represents a signaling server configuration.

Member Function Documentation

clientData()

const nlohmann::json & opentera::SignalingServerConfiguration::clientData ( ) const

inline

Returns the client data.

Returns

The client data

clientName()

const std::string & opentera::SignalingServerConfiguration::clientName ( ) const

inline

Returns the client name.

Returns

The client name

create() [1/2]

SignalingServerConfiguration opentera::SignalingServerConfiguration::create ( std::string  url, std::string  clientName, std::string  room  )

inlinestatic

Creates an signaling server configuration with the specified values.

Parameters

url	The signaling server URL
clientName	The client name
room	The room name

Returns

A signaling server configuration with the specified values

create() [2/2]

SignalingServerConfiguration opentera::SignalingServerConfiguration::create ( std::string  url, std::string  clientName, std::string  room, std::string  password  )

inlinestatic

Creates an signaling server configuration with the specified values.

Parameters

url	The signaling server URL
clientName	The client name
room	The room name
password	The signaling server password

Returns

A signaling server configuration with the specified values

createWithData() [1/2]

SignalingServerConfiguration opentera::SignalingServerConfiguration::createWithData ( std::string  url, std::string  clientName, nlohmann::json  clientData, std::string  room  )

inlinestatic

Creates an signaling server configuration with the specified values.

Parameters

url	The signaling server URL
clientName	The client name
clientData	The client data
room	The room name

Returns

A signaling server configuration with the specified values

createWithData() [2/2]

SignalingServerConfiguration opentera::SignalingServerConfiguration::createWithData ( std::string  url, std::string  clientName, nlohmann::json  clientData, std::string  room, std::string  password  )

inlinestatic

Creates an signaling server configuration with the specified values.

Parameters

url	The signaling server URL
clientName	The client name
clientData	The client data
room	The room name
password	The signaling server password

Returns

A signaling server configuration with the specified values

password()

const std::string & opentera::SignalingServerConfiguration::password ( ) const

inline

Returns the signaling server password.

Returns

The signaling server password

room()

const std::string & opentera::SignalingServerConfiguration::room ( ) const

inline

Returns the room name.

Returns

The room name

url()

const std::string & opentera::SignalingServerConfiguration::url ( ) const

inline

Returns the signaling server URL.

Returns

The signaling server URL

---

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

• SignalingServerConfiguration.h
• SignalingServerConfiguration.cpp