rs2::eth_config_device Class Reference

Ethernet configuration extension for devices that support ethernet configuration. More...

#include <rs_eth_config.hpp>

Inheritance diagram for rs2::eth_config_device:

Public Member Functions
	eth_config_device ()
	eth_config_device (rs2::device d)
bool	supports_eth_config () const
uint32_t	get_link_speed () const
rs2_eth_link_priority	get_link_priority () const
void	set_link_priority (rs2_eth_link_priority priority) const
uint32_t	get_link_timeout () const
void	set_link_timeout (uint32_t timeout) const
unsigned int	get_dds_domain () const
void	set_dds_domain (unsigned int domain)
void	get_ip_address (rs2_ip_address &configured_ip, rs2_ip_address &actual_ip) const
void	set_ip_address (const rs2_ip_address ip) const
void	get_netmask (rs2_ip_address &configured_netmask, rs2_ip_address &actual_netmask) const
void	set_netmask (const rs2_ip_address netmask) const
void	get_gateway (rs2_ip_address &configured_gateway, rs2_ip_address &actual_gateway) const
void	set_gateway (const rs2_ip_address gateway) const
void	get_dhcp_config (bool &enabled, uint8_t &timeout) const
void	set_dhcp_config (bool enabled, uint8_t timeout) const
uint32_t	get_mtu () const
void	set_mtu (uint32_t mtu) const
uint32_t	get_transmission_delay () const
void	set_transmission_delay (uint32_t delay) const
uint8_t	get_udp_ttl () const
void	set_udp_ttl (uint8_t ttl) const
void	restore_defaults ()
Public Member Functions inherited from rs2::device
std::vector< sensor >	query_sensors () const
std::string	get_type () const
std::string	get_description () const
template<class T>
T	first () const
bool	supports (rs2_camera_info info) const
const char *	get_info (rs2_camera_info info) const
void	hardware_reset ()
bool	is_in_recovery_mode ()
device &	operator= (const std::shared_ptr< rs2_device > dev)
device &	operator= (const device &dev)
	device ()
	operator bool () const
const std::shared_ptr< rs2_device > &	get () const
bool	operator< (device const &other) const
bool	is_connected () const
template<class T>
bool	is () const
template<class T>
T	as () const
virtual	~device ()
	operator std::shared_ptr< rs2_device > ()
	device (std::shared_ptr< rs2_device > dev)

Additional Inherited Members
Protected Attributes inherited from rs2::device
std::shared_ptr< rs2_device >	_dev

Detailed Description

Ethernet configuration extension for devices that support ethernet configuration.

Constructor & Destructor Documentation

eth_config_device() [1/2]

rs2::eth_config_device::eth_config_device ( )

inline

eth_config_device() [2/2]

rs2::eth_config_device::eth_config_device ( rs2::device d )

inline

Member Function Documentation

get_dds_domain()

unsigned int rs2::eth_config_device::get_dds_domain ( ) const

inline

Get current DDS domain (0-232)

get_dhcp_config()

void rs2::eth_config_device::get_dhcp_config ( bool & enabled, uint8_t & timeout ) const

inline

Get DHCP configuration

Parameters

[out]	enabled	DHCP enabled flag
[out]	timeout	DHCP timeout threshold in seconds

get_gateway()

void rs2::eth_config_device::get_gateway ( rs2_ip_address & configured_gateway, rs2_ip_address & actual_gateway ) const

inline

Get current gateway address

get_ip_address()

void rs2::eth_config_device::get_ip_address ( rs2_ip_address & configured_ip, rs2_ip_address & actual_ip ) const

inline

Get current IP address

get_link_priority()

rs2_eth_link_priority rs2::eth_config_device::get_link_priority ( ) const

inline

Get current link priority setting

get_link_speed()

uint32_t rs2::eth_config_device::get_link_speed ( ) const

inline

Get Ethernet link speed, 0 if not linked

get_link_timeout()

uint32_t rs2::eth_config_device::get_link_timeout ( ) const

inline

Get current link timeout setting in milliseconds

get_mtu()

uint32_t rs2::eth_config_device::get_mtu ( ) const

inline

Get current MTU (Maximum Transmission Unit)

get_netmask()

void rs2::eth_config_device::get_netmask ( rs2_ip_address & configured_netmask, rs2_ip_address & actual_netmask ) const

inline

Get current network mask

get_transmission_delay()

uint32_t rs2::eth_config_device::get_transmission_delay ( ) const

inline

Get current transmission delay

get_udp_ttl()

uint8_t rs2::eth_config_device::get_udp_ttl ( ) const

inline

Get current UDP packet "time to live" (TTL)

restore_defaults()

void rs2::eth_config_device::restore_defaults ( )

inline

Restores configuration to factory settings

set_dds_domain()

void rs2::eth_config_device::set_dds_domain ( unsigned int domain )

inline

Set DDS domain (0-232)

set_dhcp_config()

void rs2::eth_config_device::set_dhcp_config ( bool enabled, uint8_t timeout ) const

inline

Set DHCP configuration

Parameters

[in]	enabled	DHCP enabled flag
[in]	timeout	DHCP timeout threshold in seconds

set_gateway()

void rs2::eth_config_device::set_gateway ( const rs2_ip_address gateway ) const

inline

Set gateway address

set_ip_address()

void rs2::eth_config_device::set_ip_address ( const rs2_ip_address ip ) const

inline

Set IP address

set_link_priority()

void rs2::eth_config_device::set_link_priority ( rs2_eth_link_priority priority ) const

inline

Set link priority

set_link_timeout()

void rs2::eth_config_device::set_link_timeout ( uint32_t timeout ) const

inline

Set link timeout in milliseconds

set_mtu()

void rs2::eth_config_device::set_mtu ( uint32_t mtu ) const

inline

Set MTU (Maximum Transmission Unit)

Parameters

mtu	MTU in bytes (500-9000, in 500 byte steps)

set_netmask()

void rs2::eth_config_device::set_netmask ( const rs2_ip_address netmask ) const

inline

Set network mask

set_transmission_delay()

void rs2::eth_config_device::set_transmission_delay ( uint32_t delay ) const

inline

Set transmission delay

Parameters

delay

Transmission delay in microseconds (0-144, in 3us steps)

set_udp_ttl()

void rs2::eth_config_device::set_udp_ttl ( uint8_t ttl ) const

inline

Set UDP packet "time to live" (TTL)

Parameters

ttl	UDP TTL value (1-255)

supports_eth_config()

bool rs2::eth_config_device::supports_eth_config ( ) const

inline

Check if device supports ethernet configuration

---

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

• /builddir/build/BUILD/librealsense-2.57.7-build/librealsense-2.57.7/include/librealsense2/hpp/rs_eth_config.hpp