Class eth_config_device

Defined in File rs_eth_config.hpp

Inheritance Relationships

Base Type

public rs2::device (Class device)

Class Documentation

class eth_config_device : public rs2::device 

Ethernet configuration extension for devices that support ethernet configuration.

Public Functions

inline eth_config_device()

inline eth_config_device(rs2::device d)

inline bool supports_eth_config() const: Check if device supports ethernet configuration

inline uint32_t get_link_speed() const: Get Ethernet link speed, 0 if not linked

inline rs2_eth_link_priority get_link_priority() const: Get current link priority setting

inline void set_link_priority(rs2_eth_link_priority priority) const: Set link priority

inline uint32_t get_link_timeout() const: Get current link timeout setting in milliseconds

inline void set_link_timeout(uint32_t timeout) const: Set link timeout in milliseconds

inline unsigned int get_dds_domain() const: Get current DDS domain (0-232)

inline void set_dds_domain(unsigned int domain): Set DDS domain (0-232)

inline void get_ip_address(rs2_ip_address &configured_ip, rs2_ip_address &actual_ip) const: Get current IP address

inline void set_ip_address(const rs2_ip_address ip) const: Set IP address

inline void get_netmask(rs2_ip_address &configured_netmask, rs2_ip_address &actual_netmask) const: Get current network mask

inline void set_netmask(const rs2_ip_address netmask) const: Set network mask

inline void get_gateway(rs2_ip_address &configured_gateway, rs2_ip_address &actual_gateway) const: Get current gateway address

inline void set_gateway(const rs2_ip_address gateway) const: Set gateway address

inline void get_dhcp_config(bool &enabled, uint8_t &timeout) const

Get DHCP configuration

Parameters:

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

inline void set_dhcp_config(bool enabled, uint8_t timeout) const

Set DHCP configuration

Parameters:

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

inline uint32_t get_mtu() const: Get current MTU (Maximum Transmission Unit)

inline void set_mtu(uint32_t mtu) const

Set MTU (Maximum Transmission Unit)

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

inline uint32_t get_transmission_delay() const: Get current transmission delay

inline void set_transmission_delay(uint32_t delay) const

Set transmission delay

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

inline void restore_defaults(): Restores configuration to factory settings