Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Data Structures | Typedefs | Enumerations | Functions
IPv4 Device Tracking Configuration And Status [OPENAPI_IPV4_DEVICE_TRACKING]

Data Structures

struct  OPEN_IPV4DT_CLEAR_REQUEST_s
 
struct  OPEN_IPV4DT_ENTRIES_COUNT_s
 
struct  OPEN_IPV4DT_ENTRY_s
 
struct  OPEN_IPV4DT_SHOW_REQUEST_s
 

Typedefs

typedef struct OPEN_IPV4DT_CLEAR_REQUEST_s OPEN_IPV4DT_CLEAR_REQUEST_t
 
typedef enum OPEN_IPV4DT_CLEAR_s OPEN_IPV4DT_CLEAR_t
 
typedef struct OPEN_IPV4DT_ENTRIES_COUNT_s OPEN_IPV4DT_ENTRIES_COUNT_t
 
typedef struct OPEN_IPV4DT_ENTRY_s OPEN_IPV4DT_ENTRY_t
 
typedef struct OPEN_IPV4DT_SHOW_REQUEST_s OPEN_IPV4DT_SHOW_REQUEST_t
 

Enumerations

enum  OPEN_IPV4DT_CLEAR_s { OPEN_IPV4DT_CLEAR_ALL, OPEN_IPV4DT_CLEAR_HOST_IP, OPEN_IPV4DT_CLEAR_HOST_MAC, OPEN_IPV4DT_CLEAR_INTERFACE }
 
enum  OPEN_IPV4DT_GET_ALL_TYPE_t { OPEN_IPV4DT_GET_ALL = 0, OPEN_IPV4DT_GET_ALL_ACTIVE, OPEN_IPV4DT_GET_ALL_INACTIVE, OPEN_IPV4DT_GET_COUNT }
 
enum  OPEN_IPV4DT_GET_TYPE_t { OPEN_IPV4DT_GET_FIRST = 0, OPEN_IPV4DT_GET, OPEN_IPV4DT_GET_NEXT }
 
enum  OPEN_IPV4DT_Source_t { OPEN_IPV4DT_SOURCE_ARP = 0, OPEN_IPV4DT_SOURCE_DHCP }
 
enum  OPEN_IPV4DT_State_t { OPEN_IPV4DT_STATE_INACTIVE = 0, OPEN_IPV4DT_STATE_ACTIVE }
 

Functions

open_error_t openapiIpv4dtAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *enable)
 Gets the Ipv4dt Admin mode. More...
 
open_error_t openapiIpv4dtAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t enable)
 Sets the Ipv4dt Admin mode. More...
 
open_error_t openapiIpv4dtClearEntries (openapiClientHandle_t *client_handle, OPEN_IPV4DT_CLEAR_REQUEST_t *ipv4dtClear)
 Clears the Ipv4dt Entries. More...
 
open_error_t openapiIpv4dtEntriesCountGet (openapiClientHandle_t *client_handle, OPEN_IPV4DT_ENTRIES_COUNT_t *ipv4dtEntriesCount)
 Gets the Ipv4dt Entries Count. More...
 
open_error_t openapiIpv4dtIntfMaxGet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t *intfMax)
 Gets the Ipv4dt Interface Maximum limit. More...
 
open_error_t openapiIpv4dtIntfMaxSet (openapiClientHandle_t *client_handle, uint32_t intf, uint32_t intfMax)
 Sets the Ipv4dt Interface Maximum limit. More...
 
open_error_t openapiIpv4dtIntfNextGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *nextIntIfNum)
 Get the Next Valid Ipv4dt Interface. More...
 
open_error_t openapiIpv4dtIntfSupported (openapiClientHandle_t *client_handle, uint32_t intIfNum, OPEN_BOOL_t *isSupported)
 Check the Ipv4dt Interface is supported or not. More...
 
open_error_t openapiIpv4dtProbeAutoSourceGet (openapiClientHandle_t *client_handle, uint32_t *host, uint32_t *mask)
 Gets the Ipv4dt Probe Auto-Source parameters. More...
 
open_error_t openapiIpv4dtProbeAutoSourceSet (openapiClientHandle_t *client_handle, uint32_t *host, uint32_t *mask)
 Sets the Ipv4dt Probe Auto-Source parameters. More...
 
open_error_t openapiIpv4dtProbeCountGet (openapiClientHandle_t *client_handle, uint32_t *count)
 Gets the Ipv4dt Probe Count. More...
 
open_error_t openapiIpv4dtProbeCountSet (openapiClientHandle_t *client_handle, uint32_t count)
 Sets the Ipv4dt Probe Count. More...
 
open_error_t openapiIpv4dtProbeDelayGet (openapiClientHandle_t *client_handle, uint32_t *delay)
 Gets the Ipv4dt Probe Delay. More...
 
open_error_t openapiIpv4dtProbeDelaySet (openapiClientHandle_t *client_handle, uint32_t delay)
 Sets the Ipv4dt Probe Delay. More...
 
open_error_t openapiIpv4dtProbeIntervalGet (openapiClientHandle_t *client_handle, uint32_t *delay)
 Gets the Ipv4dt Probe Interval. More...
 
open_error_t openapiIpv4dtProbeIntervalSet (openapiClientHandle_t *client_handle, uint32_t delay)
 Sets the Ipv4dt Probe Interval. More...
 
open_error_t openapiIpv4dtProbeModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *enable)
 Gets the Ipv4dt Probe mode. More...
 
open_error_t openapiIpv4dtProbeModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t enable)
 Sets the Ipv4dt Probe mode. More...
 
open_error_t openapiIpv4dtTableGetNext (openapiClientHandle_t *client_handle, OPEN_IPV4DT_SHOW_REQUEST_t *ipv4dtShow, OPEN_IPV4DT_ENTRY_t *entry)
 Gets the Ipv4dt Entries. More...
 

Detailed Description

Function Documentation

open_error_t openapiIpv4dtAdminModeGet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t enable 
)

Gets the Ipv4dt Admin mode.

Parameters
[in]clientHandleOpEN client handle
[out]enableMode (Enable or Disable).
Return values
OPEN_E_NONEAdmin mode get is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_FAILFailed to get the admin mode

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtAdminModeSet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t  enable 
)

Sets the Ipv4dt Admin mode.

Parameters
[in]clientHandleOpEN client handle
[in]enableMode (Enable or Disable).
Return values
OPEN_E_NONEAdmin mode set is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_FAILFailed to set the admin mode

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtClearEntries ( openapiClientHandle_t client_handle,
OPEN_IPV4DT_CLEAR_REQUEST_t ipv4dtClear 
)

Clears the Ipv4dt Entries.

Parameters
[in]clientHandleOpEN client handle
[in]ipv4dtClearIPv4DT Entries Clear
Return values
OPEN_E_NONEEntries clear is successful
OPEN_E_FAILFailed to clear the entries.
OPEN_E_PARAMParameters are not valid

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtEntriesCountGet ( openapiClientHandle_t client_handle,
OPEN_IPV4DT_ENTRIES_COUNT_t ipv4dtEntriesCount 
)

Gets the Ipv4dt Entries Count.

Parameters
[in]clientHandleOpEN client handle
[in]ipv4dtEntriesCountEntries Count (ARP, DHCP)
Return values
OPEN_E_NONEEntries count get is successful
OPEN_E_FAILFailed to get the entries count
OPEN_E_PARAMParameters are not valid

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtIntfMaxGet ( openapiClientHandle_t client_handle,
uint32_t  intf,
uint32_t *  intfMax 
)

Gets the Ipv4dt Interface Maximum limit.

Parameters
[in]clientHandleOpEN client handle
[in]intfInterface number
[out]intfMaxMax Limit
Return values
OPEN_E_NONEMax limit get is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_UNAVAILInterface is not supported
OPEN_E_INTERNALFailed to set the max limit on a interface

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtIntfMaxSet ( openapiClientHandle_t client_handle,
uint32_t  intf,
uint32_t  intfMax 
)

Sets the Ipv4dt Interface Maximum limit.

Parameters
[in]clientHandleOpEN client handle
[in]intfInterface number
[in]intfMaxMax Limit
Return values
OPEN_E_NONEMax limit set on a interface is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_UNAVAILInterface is not supported
OPEN_E_INTERNALFailed to set the max limit on a interface

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtIntfNextGet ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
uint32_t *  nextIntIfNum 
)

Get the Next Valid Ipv4dt Interface.

Parameters
[in]clientHandleOpEN client handle
[in]intIfNumCurrent Interface number
[out]nextIntIfNumNext Interface number
Return values
OPEN_E_NONENext Interface get is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_UNAVAILInterface is not supported
OPEN_E_INTERNALIf failed to get the next interface

OpEN API Version: 1.19

open_error_t openapiIpv4dtIntfSupported ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
OPEN_BOOL_t isSupported 
)

Check the Ipv4dt Interface is supported or not.

Parameters
[in]clientHandleOpEN client handle
[in]intIfNumInterface number
[out]isSupportedOPEN_TRUE if interface is supported OPEN_FALSE if interface is not supported
Return values
OPEN_E_NONEInterface is supported
OPEN_E_PARAMParameters are not valid

OpEN API Version: 1.19

open_error_t openapiIpv4dtProbeAutoSourceGet ( openapiClientHandle_t client_handle,
uint32_t *  host,
uint32_t *  mask 
)

Gets the Ipv4dt Probe Auto-Source parameters.

Parameters
[in]clientHandleOpEN client handle
[out]hostAuto-source Host.
[out]maskAuto-source Mask.
Return values
OPEN_E_NONEAuto source get is successful
OPEN_E_FAILFailed to get the auto source parameters
OPEN_E_PARAMParameters are not valid

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtProbeAutoSourceSet ( openapiClientHandle_t client_handle,
uint32_t *  host,
uint32_t *  mask 
)

Sets the Ipv4dt Probe Auto-Source parameters.

Parameters
[in]clientHandleOpEN client handle
[out]hostAuto-source Host.
[out]maskAuto-source Mask.
Return values
OPEN_E_NONEAuto source set is successful
OPEN_E_FAILFailed to set the auto source parameters
OPEN_E_PARAMParameters are not valid

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtProbeCountGet ( openapiClientHandle_t client_handle,
uint32_t *  count 
)

Gets the Ipv4dt Probe Count.

Parameters
[in]clientHandleOpEN client handle
[out]countProbe Count.
Return values
OPEN_E_NONEProbe count get is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_FAILFailed to get the probe count

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtProbeCountSet ( openapiClientHandle_t client_handle,
uint32_t  count 
)

Sets the Ipv4dt Probe Count.

Parameters
[in]clientHandleOpEN client handle
[in]countProbe Count.
Return values
OPEN_E_NONEProbe count set is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_INTERNALFailed to set the probe count

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtProbeDelayGet ( openapiClientHandle_t client_handle,
uint32_t *  delay 
)

Gets the Ipv4dt Probe Delay.

Parameters
[in]clientHandleOpEN client handle
[out]delayProbe Delay.
Return values
OPEN_E_NONEProbe delay get is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_FAILFailed to get the probe delay

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtProbeDelaySet ( openapiClientHandle_t client_handle,
uint32_t  delay 
)

Sets the Ipv4dt Probe Delay.

Parameters
[in]clientHandleOpEN client handle
[in]delayProbe Delay.
Return values
OPEN_E_NONEProbe delay set is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_INTERNALFailed to set the probe delay

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtProbeIntervalGet ( openapiClientHandle_t client_handle,
uint32_t *  delay 
)

Gets the Ipv4dt Probe Interval.

Parameters
[in]clientHandleOpEN client handle
[out]intervalProbe Interval.
Return values
OPEN_E_NONEProbe interval get is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_FAILFailed to get the probe interval

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtProbeIntervalSet ( openapiClientHandle_t client_handle,
uint32_t  delay 
)

Sets the Ipv4dt Probe Interval.

Parameters
[in]clientHandleOpEN client handle
[in]intervalProbe Interval.
Return values
OPEN_E_NONEProbe interval set is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_INTERNALFailed to set the probe interval

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtProbeModeGet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t enable 
)

Gets the Ipv4dt Probe mode.

Parameters
[in]clientHandleOpEN client handle
[out]enableMode (Enable or Disable).
Return values
OPEN_E_NONEProbe mode get is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_FAILFailed to get the probe mode

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtProbeModeSet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t  enable 
)

Sets the Ipv4dt Probe mode.

Parameters
[in]clientHandleOpEN client handle
[in]enableMode (Enable or Disable).
Return values
OPEN_E_NONEProbe mode set is successful
OPEN_E_PARAMParameters are not valid
OPEN_E_FAILFailed to set the probe mode

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.
open_error_t openapiIpv4dtTableGetNext ( openapiClientHandle_t client_handle,
OPEN_IPV4DT_SHOW_REQUEST_t ipv4dtShow,
OPEN_IPV4DT_ENTRY_t entry 
)

Gets the Ipv4dt Entries.

Parameters
[in]clientHandleOpEN client handle
[in]ipv4dtShowShow request parameters
[out]entryIPv4DT Entry
Return values
OPEN_E_NONENext Entry get is successful
OPEN_E_FAILFailed to get the next entry
OPEN_E_PARAMParameters are not valid

OpEN API Version: 1.19

Examples:
ipv4_device_tracking_example.c.