rs_eth_config.h

Go to the documentation of this file.

/* License: Apache 2.0. See LICENSE file in root directory.
   Copyright(c) 2025 RealSense, Inc. All Rights Reserved. */

#ifndef LIBREALSENSE_RS2_ETH_CONFIG_H
#define LIBREALSENSE_RS2_ETH_CONFIG_H

#ifdef __cplusplus
extern "C"
{
#endif

#include "rs_types.h"

typedef enum rs2_eth_link_priority
{
    RS2_LINK_PRIORITY_USB_ONLY = 0,  
    RS2_LINK_PRIORITY_ETH_ONLY = 1,  
    RS2_LINK_PRIORITY_ETH_FIRST = 2, 
    RS2_LINK_PRIORITY_USB_FIRST = 3, 
    RS2_LINK_PRIORITY_DYNAMIC_BIT = 0x10, 
    RS2_LINK_PRIORITY_DYNAMIC_ETH_FIRST = RS2_LINK_PRIORITY_ETH_FIRST | RS2_LINK_PRIORITY_DYNAMIC_BIT, 
    RS2_LINK_PRIORITY_DYNAMIC_USB_FIRST = RS2_LINK_PRIORITY_USB_FIRST | RS2_LINK_PRIORITY_DYNAMIC_BIT, 
    RS2_LINK_PRIORITY_COUNT 
} rs2_eth_link_priority;

const char * rs2_eth_link_priority_to_string( rs2_eth_link_priority priority );

typedef uint8_t rs2_ip_address[4];


// Device capability check functions
int rs2_supports_eth_config( const rs2_device * device, rs2_error ** error );

unsigned int rs2_get_link_speed( const rs2_device * device, rs2_error ** error );

rs2_eth_link_priority rs2_get_link_priority( const rs2_device * device, rs2_error ** error );

void rs2_set_link_priority( const rs2_device * device, rs2_eth_link_priority priority, rs2_error ** error );

unsigned int rs2_get_link_timeout( const rs2_device * device, rs2_error ** error );

void rs2_set_link_timeout( const rs2_device * device, unsigned int timeout, rs2_error ** error );

unsigned int rs2_get_dds_domain( const rs2_device * device, rs2_error ** error );

void rs2_set_dds_domain( const rs2_device * device, unsigned int domain, rs2_error ** error );

void rs2_get_ip_address( const rs2_device * device, rs2_ip_address configured_ip, rs2_ip_address actual_ip, rs2_error ** error );

void rs2_set_ip_address( const rs2_device * device, const rs2_ip_address ip, rs2_error ** error );

void rs2_get_netmask( const rs2_device * device, rs2_ip_address configured_netmask, rs2_ip_address actual_netmask, rs2_error ** error );

void rs2_set_netmask( const rs2_device * device, const rs2_ip_address netmask, rs2_error ** error );

void rs2_get_gateway( const rs2_device * device, rs2_ip_address configured_gateway, rs2_ip_address actual_gateway, rs2_error ** error );

void rs2_set_gateway( const rs2_device * device, const rs2_ip_address gateway, rs2_error ** error );

void rs2_get_dhcp_config( const rs2_device * device, int * enabled, unsigned int * timeout, rs2_error ** error );

void rs2_set_dhcp_config( const rs2_device * device, int enabled, unsigned int timeout, rs2_error ** error );

unsigned int rs2_get_mtu( const rs2_device * device, rs2_error ** error );

void rs2_set_mtu( const rs2_device * device, unsigned int mtu, rs2_error ** error );

unsigned int rs2_get_transmission_delay( const rs2_device * device, rs2_error ** error );

void rs2_set_transmission_delay( const rs2_device * device, unsigned int delay, rs2_error ** error );

unsigned int rs2_get_udp_ttl( const rs2_device * device, rs2_error ** error );

void rs2_set_udp_ttl( const rs2_device * device, unsigned int ttl, rs2_error ** error );

void rs2_restore_default_eth_config( const rs2_device * device, rs2_error ** error );

#ifdef __cplusplus
}
#endif

#endif /* LIBREALSENSE_RS2_ETH_CONFIG_H */