The server connection description class. More...

#include <slamtec_remote_objects.hxx>

Inheritance diagram for rp::standalone::aurora::SDKServerConnectionDesc:

Public Member Functions
	SDKServerConnectionDesc (const slamtec_aurora_sdk_server_connection_info_t &info)
	Create the server connection description with a server connection info structure. More...

	SDKServerConnectionDesc (const SDKServerConnectionDesc &other)

	SDKServerConnectionDesc (const std::vector< SDKConnectionInfo > &src)

	SDKServerConnectionDesc (const char ip, int port=SLAMTEC_AURORA_SDK_REMOTE_SERVER_DEFAULT_PORT, const char proto=SLAMTEC_AURORA_SDK_REMOTE_SERVER_DEFAULT_PROTOCOL)
	Create the server connection description with one connection option with IP address, port and protocol. More...

SDKServerConnectionDesc &	operator= (const SDKServerConnectionDesc &other)

std::vector< SDKConnectionInfo >	toVector () const
	Convert the server connection description to a vector of connection info. More...

SDKServerConnectionDesc &	operator= (const std::vector< SDKConnectionInfo > &src)

size_t	size () const
	Get the count of the server connection description. More...

size_t	capacity () const
	Get the capacity of the connection description this object can hold. More...

void	clear ()
	Clear the connection description. More...

bool	push_back (const slamtec_aurora_sdk_connection_info_t &info)
	Push a connection info to the server connection description. More...

void	pop_back ()
	Pop a connection info from the server connection description. More...

const SDKConnectionInfo &	operator[] (size_t index) const
	Get the connection info at the specified index. More...

const SDKConnectionInfo &	at (size_t index) const
	Get the connection info at the specified index. More...

Additional Inherited Members
Public Attributes inherited from _slamtec_aurora_sdk_server_connection_info_t
slamtec_aurora_sdk_connection_info_t	connection_info [8]
	The connection methods. More...

uint32_t	connection_count
	The number of connection methods. More...

Detailed Description

The server connection description class.

This class is used to store the server connection information.

Constructor & Destructor Documentation

◆ SDKServerConnectionDesc() [1/2]

rp::standalone::aurora::SDKServerConnectionDesc::SDKServerConnectionDesc ( const slamtec_aurora_sdk_server_connection_info_t & info )

inline

Create the server connection description with a server connection info structure.

This constructor is used to create a server connection description with a server connection info structure.

Parameters

[in] info The server connection info

◆ SDKServerConnectionDesc() [2/2]

rp::standalone::aurora::SDKServerConnectionDesc::SDKServerConnectionDesc	(	const char *	ip,
		int	port = `SLAMTEC_AURORA_SDK_REMOTE_SERVER_DEFAULT_PORT`,
		const char *	proto = `SLAMTEC_AURORA_SDK_REMOTE_SERVER_DEFAULT_PROTOCOL`
	)

inline

Create the server connection description with one connection option with IP address, port and protocol.

This constructor is used to create a server connection description with IP address, port and protocol.

Parameters

[in]	ip	The IP address
[in]	port	The port
[in]	proto	The protocol

Member Function Documentation

◆ at()

const SDKConnectionInfo& rp::standalone::aurora::SDKServerConnectionDesc::at ( size_t index ) const

inline

Get the connection info at the specified index.

This function is used to get the connection info at the specified index.

Parameters

[in] index The index

Returns: The connection info

◆ capacity()

size_t rp::standalone::aurora::SDKServerConnectionDesc::capacity ( ) const

inline

Get the capacity of the connection description this object can hold.

This function is used to get the capacity of the connection description this object can hold.

Returns: The capacity of the connection description

◆ clear()

void rp::standalone::aurora::SDKServerConnectionDesc::clear ( )

inline

Clear the connection description.

This function is used to clear the connection description.

◆ operator[]()

const SDKConnectionInfo& rp::standalone::aurora::SDKServerConnectionDesc::operator[] ( size_t index ) const

inline

Get the connection info at the specified index.

This function is used to get the connection info at the specified index.

Parameters

[in] index The index

Returns: The connection info

◆ pop_back()

void rp::standalone::aurora::SDKServerConnectionDesc::pop_back ( )

inline

Pop a connection info from the server connection description.

This function is used to pop a connection info from the server connection description.

◆ push_back()

bool rp::standalone::aurora::SDKServerConnectionDesc::push_back ( const slamtec_aurora_sdk_connection_info_t & info )

inline

Push a connection info to the server connection description.

This function is used to push a connection info to the server connection description.

Parameters

[in] info The connection info

Returns: True if the push is successful, false otherwise

◆ size()

size_t rp::standalone::aurora::SDKServerConnectionDesc::size ( ) const

inline

Get the count of the server connection description.

This function is used to get the count of the server connection description.

Returns: The count of the server connection description

◆ toVector()

std::vector<SDKConnectionInfo> rp::standalone::aurora::SDKServerConnectionDesc::toVector ( ) const

inline

Convert the server connection description to a vector of connection info.

This function is used to convert the server connection description to a vector of connection info.

Returns: The vector of connection info

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

inc/cxx/slamtec_remote_objects.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SDKServerConnectionDesc() [1/2]

◆ SDKServerConnectionDesc() [2/2]

Member Function Documentation

◆ at()

◆ capacity()

◆ clear()

◆ operator[]()

◆ pop_back()

◆ push_back()

◆ size()

◆ toVector()