Represents a data channel configuration. More...

#include <DataChannelConfiguration.h>

Public Member Functions
	DataChannelConfiguration (const DataChannelConfiguration &other)=default

	DataChannelConfiguration (DataChannelConfiguration &&other)=default

bool	ordered () const
	Indicates if the message order must be preserved. More...

const absl::optional< int > &	maxPacketLifeTime () const
	Returns the maximum number of time a message can be retransmitted. More...

const absl::optional< int > &	maxRetransmits () const
	Returns the maximum number of time a message can be retransmitted. More...

const std::string &	protocol () const
	Returns the data channel protocol. More...

	operator webrtc::DataChannelInit () const

DataChannelConfiguration &	operator= (const DataChannelConfiguration &other)=default

DataChannelConfiguration &	operator= (DataChannelConfiguration &&other)=default

Static Public Member Functions
static DataChannelConfiguration	create ()
	Creates a data channel configuration with default values. More...

static DataChannelConfiguration	create (bool ordered)
	Creates a data channel configuration with the specified value. More...

static DataChannelConfiguration	createProtocol (std::string protocol)
	Creates a data channel configuration with the specified value. More...

static DataChannelConfiguration	create (bool ordered, std::string protocol)
	Creates a data channel configuration with the specified values. More...

static DataChannelConfiguration	createMaxPacketLifeTime (int maxPacketLifeTime)
	Creates a data channel configuration with the specified value. More...

static DataChannelConfiguration	createMaxPacketLifeTime (bool ordered, int maxPacketLifeTime)
	Creates a data channel configuration with the specified values. More...

static DataChannelConfiguration	createMaxPacketLifeTime (int maxPacketLifeTime, std::string protocol)
	Creates a data channel configuration with the specified values. More...

static DataChannelConfiguration	createMaxPacketLifeTime (bool ordered, int maxPacketLifeTime, std::string protocol)
	Creates a data channel configuration with the specified values. More...

static DataChannelConfiguration	createMaxRetransmits (int maxRetransmits)
	Creates a data channel configuration with the specified value. More...

static DataChannelConfiguration	createMaxRetransmits (bool ordered, int maxRetransmits)
	Creates a data channel configuration with the specified values. More...

static DataChannelConfiguration	createMaxRetransmits (int maxRetransmits, std::string protocol)
	Creates a data channel configuration with the specified values. More...

static DataChannelConfiguration	createMaxRetransmits (bool ordered, int maxRetransmits, std::string protocol)
	Creates a data channel configuration with the specified values. More...

Detailed Description

Represents a data channel configuration.

Member Function Documentation

◆ create() [1/3]

DataChannelConfiguration opentera::DataChannelConfiguration::create ( )

inlinestatic

Creates a data channel configuration with default values.

Returns: A data channel configuration with default values

◆ create() [2/3]

DataChannelConfiguration opentera::DataChannelConfiguration::create ( bool ordered )

inlinestatic

Creates a data channel configuration with the specified value.

Parameters

ordered Indicates if the message order must be preserved

Returns: A data channel configuration with the specified value

◆ create() [3/3]

DataChannelConfiguration opentera::DataChannelConfiguration::create	(	bool	ordered,
		std::string	protocol
	)

inlinestatic

Creates a data channel configuration with the specified values.

Parameters

ordered	Indicates if the message order must be preserved
protocol	The data channel protocol

Returns: A data channel configuration with the specified values

◆ createMaxPacketLifeTime() [1/4]

DataChannelConfiguration opentera::DataChannelConfiguration::createMaxPacketLifeTime	(	bool	ordered,
		int	maxPacketLifeTime
	)

inlinestatic

Creates a data channel configuration with the specified values.

Parameters

ordered	Indicates if the message order must be preserved
maxPacketLifeTime	Indicates the amount of time a message can be retransmitted (ms)

Returns: A data channel configuration with the specified values

◆ createMaxPacketLifeTime() [2/4]

DataChannelConfiguration opentera::DataChannelConfiguration::createMaxPacketLifeTime	(	bool	ordered,
		int	maxPacketLifeTime,
		std::string	protocol
	)

inlinestatic

Creates a data channel configuration with the specified values.

Parameters

ordered	Indicates if the message order must be preserved
maxPacketLifeTime	Indicates the amount of time a message can be retransmitted (ms)
protocol	The data channel protocol

Returns: A data channel configuration with the specified values

◆ createMaxPacketLifeTime() [3/4]

DataChannelConfiguration opentera::DataChannelConfiguration::createMaxPacketLifeTime ( int maxPacketLifeTime )

inlinestatic

Creates a data channel configuration with the specified value.

Parameters

maxPacketLifeTime Indicates the amount of time a message can be retransmitted (ms)

Returns: A data channel configuration with the specified value

◆ createMaxPacketLifeTime() [4/4]

DataChannelConfiguration opentera::DataChannelConfiguration::createMaxPacketLifeTime	(	int	maxPacketLifeTime,
		std::string	protocol
	)

inlinestatic

Creates a data channel configuration with the specified values.

Parameters

maxPacketLifeTime	Indicates the amount of time a message can be retransmitted (ms)
protocol	The data channel protocol

Returns: A data channel configuration with the specified values

◆ createMaxRetransmits() [1/4]

DataChannelConfiguration opentera::DataChannelConfiguration::createMaxRetransmits	(	bool	ordered,
		int	maxRetransmits
	)

inlinestatic

Creates a data channel configuration with the specified values.

Parameters

ordered	Indicates if the message order must be preserved
maxRetransmits	Indicates the maximum number of time a message can be retransmitted

Returns: A data channel configuration with the specified values

◆ createMaxRetransmits() [2/4]

DataChannelConfiguration opentera::DataChannelConfiguration::createMaxRetransmits	(	bool	ordered,
		int	maxRetransmits,
		std::string	protocol
	)

inlinestatic

Creates a data channel configuration with the specified values.

Parameters

ordered	Indicates if the message order must be preserved
maxRetransmits	Indicates the maximum number of time a message can be retransmitted
protocol	The data channel protocol

Returns: A data channel configuration with the specified values

◆ createMaxRetransmits() [3/4]

DataChannelConfiguration opentera::DataChannelConfiguration::createMaxRetransmits ( int maxRetransmits )

inlinestatic

Creates a data channel configuration with the specified value.

Parameters

maxRetransmits Indicates the maximum number of time a message can be retransmitted

Returns: A data channel configuration with the specified value

◆ createMaxRetransmits() [4/4]

DataChannelConfiguration opentera::DataChannelConfiguration::createMaxRetransmits	(	int	maxRetransmits,
		std::string	protocol
	)

inlinestatic

Creates a data channel configuration with the specified values.

Parameters

maxRetransmits	Indicates the maximum number of time a message can be retransmitted
protocol	The data channel protocol

Returns: A data channel configuration with the specified values

◆ createProtocol()

DataChannelConfiguration opentera::DataChannelConfiguration::createProtocol ( std::string protocol )

inlinestatic

Creates a data channel configuration with the specified value.

Parameters

protocol The data channel protocol

Returns: A data channel configuration with the specified value

◆ maxPacketLifeTime()

const absl::optional< int > & opentera::DataChannelConfiguration::maxPacketLifeTime ( ) const

inline

Returns the maximum number of time a message can be retransmitted.

Returns: The maximum number of time a message can be retransmitted

◆ maxRetransmits()

const absl::optional< int > & opentera::DataChannelConfiguration::maxRetransmits ( ) const

inline

Returns the maximum number of time a message can be retransmitted.

Returns: The maximum number of time a message can be retransmitted

◆ operator webrtc::DataChannelInit()

DataChannelConfiguration::operator webrtc::DataChannelInit ( ) const

explicit

Converts a AudioSourceConfiguration to a webrtc::DataChannelInit.

Returns: The converted webrtc::DataChannelInit

◆ ordered()

bool opentera::DataChannelConfiguration::ordered ( ) const

inline

Indicates if the message order must be preserved.

Returns: true if the message order must be preserved

◆ protocol()

const std::string & opentera::DataChannelConfiguration::protocol ( ) const

inline

Returns the data channel protocol.

Returns: The data channel protocol

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

DataChannelConfiguration.h
DataChannelConfiguration.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ createMaxPacketLifeTime() [1/4]

◆ createMaxPacketLifeTime() [2/4]

◆ createMaxPacketLifeTime() [3/4]

◆ createMaxPacketLifeTime() [4/4]

◆ createMaxRetransmits() [1/4]

◆ createMaxRetransmits() [2/4]

◆ createMaxRetransmits() [3/4]

◆ createMaxRetransmits() [4/4]

◆ createProtocol()

◆ maxPacketLifeTime()

◆ maxRetransmits()

◆ operator webrtc::DataChannelInit()

◆ ordered()

◆ protocol()