rp::standalone::aurora::SDKConnectionInfo Class Reference

The connection info class. More...

#include <slamtec_remote_objects.hxx>

Inheritance diagram for rp::standalone::aurora::SDKConnectionInfo:

Public Member Functions
	SDKConnectionInfo (const char *ip, int port=SLAMTEC_AURORA_SDK_REMOTE_SERVER_DEFAULT_PORT, const char *proto=SLAMTEC_AURORA_SDK_REMOTE_SERVER_DEFAULT_PROTOCOL)
	The constructor with IP address, port and protocol. More...
	SDKConnectionInfo (const SDKConnectionInfo &other)
SDKConnectionInfo &	operator= (const SDKConnectionInfo &other)
	SDKConnectionInfo (const slamtec_aurora_sdk_connection_info_t &other)
std::string	toLocatorString () const
	Convert the connection info to a locator string. More...
bool	fromLocatorString (const char *input)
	Parse the connection info from a locator string. More...

Additional Inherited Members
Public Attributes inherited from _slamtec_aurora_sdk_connection_info_t
char	protocol_type [16]
	The protocol type. More...
char	address [64]
	The address. More...
uint16_t	port
	The port. More...

Detailed Description

The connection info class.

This class is used to store the connection information.

Constructor & Destructor Documentation

SDKConnectionInfo()

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

inline

The constructor with IP address, port and protocol.

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

Parameters

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

Member Function Documentation

fromLocatorString()

bool rp::standalone::aurora::SDKConnectionInfo::fromLocatorString ( const char *  input )

inline

Parse the connection info from a locator string.

This function is used to parse the connection info from a locator string.

The format of the locator string is "[protocol/]ip[:port]".

Parameters

[in]

input

The locator string

Returns

True if the parsing is successful, false otherwise

toLocatorString()

std::string rp::standalone::aurora::SDKConnectionInfo::toLocatorString ( ) const

inline

Convert the connection info to a locator string.

This function is used to convert the connection info to a locator string.

The format of the locator string is "[protocol/]ip[:port]".

Returns

The locator string

---

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

• inc/cxx/slamtec_remote_objects.hxx