Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
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 |
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... | |
open_error_t openapiIpv4dtAdminModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | enable | ||
) |
Gets the Ipv4dt Admin mode.
[in] | clientHandle | OpEN client handle |
[out] | enable | Mode (Enable or Disable). |
OPEN_E_NONE | Admin mode get is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_FAIL | Failed to get the admin mode |
OpEN API Version: 1.19
open_error_t openapiIpv4dtAdminModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | enable | ||
) |
Sets the Ipv4dt Admin mode.
[in] | clientHandle | OpEN client handle |
[in] | enable | Mode (Enable or Disable). |
OPEN_E_NONE | Admin mode set is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_FAIL | Failed to set the admin mode |
OpEN API Version: 1.19
open_error_t openapiIpv4dtClearEntries | ( | openapiClientHandle_t * | client_handle, |
OPEN_IPV4DT_CLEAR_REQUEST_t * | ipv4dtClear | ||
) |
Clears the Ipv4dt Entries.
[in] | clientHandle | OpEN client handle |
[in] | ipv4dtClear | IPv4DT Entries Clear |
OPEN_E_NONE | Entries clear is successful |
OPEN_E_FAIL | Failed to clear the entries. |
OPEN_E_PARAM | Parameters are not valid |
OpEN API Version: 1.19
open_error_t openapiIpv4dtEntriesCountGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_IPV4DT_ENTRIES_COUNT_t * | ipv4dtEntriesCount | ||
) |
Gets the Ipv4dt Entries Count.
[in] | clientHandle | OpEN client handle |
[in] | ipv4dtEntriesCount | Entries Count (ARP, DHCP) |
OPEN_E_NONE | Entries count get is successful |
OPEN_E_FAIL | Failed to get the entries count |
OPEN_E_PARAM | Parameters are not valid |
OpEN API Version: 1.19
open_error_t openapiIpv4dtIntfMaxGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t * | intfMax | ||
) |
Gets the Ipv4dt Interface Maximum limit.
[in] | clientHandle | OpEN client handle |
[in] | intf | Interface number |
[out] | intfMax | Max Limit |
OPEN_E_NONE | Max limit get is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_UNAVAIL | Interface is not supported |
OPEN_E_INTERNAL | Failed to set the max limit on a interface |
OpEN API Version: 1.19
open_error_t openapiIpv4dtIntfMaxSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intf, | ||
uint32_t | intfMax | ||
) |
Sets the Ipv4dt Interface Maximum limit.
[in] | clientHandle | OpEN client handle |
[in] | intf | Interface number |
[in] | intfMax | Max Limit |
OPEN_E_NONE | Max limit set on a interface is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_UNAVAIL | Interface is not supported |
OPEN_E_INTERNAL | Failed to set the max limit on a interface |
OpEN API Version: 1.19
open_error_t openapiIpv4dtIntfNextGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t * | nextIntIfNum | ||
) |
Get the Next Valid Ipv4dt Interface.
[in] | clientHandle | OpEN client handle |
[in] | intIfNum | Current Interface number |
[out] | nextIntIfNum | Next Interface number |
OPEN_E_NONE | Next Interface get is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_UNAVAIL | Interface is not supported |
OPEN_E_INTERNAL | If 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.
[in] | clientHandle | OpEN client handle |
[in] | intIfNum | Interface number |
[out] | isSupported | OPEN_TRUE if interface is supported OPEN_FALSE if interface is not supported |
OPEN_E_NONE | Interface is supported |
OPEN_E_PARAM | Parameters 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.
[in] | clientHandle | OpEN client handle |
[out] | host | Auto-source Host. |
[out] | mask | Auto-source Mask. |
OPEN_E_NONE | Auto source get is successful |
OPEN_E_FAIL | Failed to get the auto source parameters |
OPEN_E_PARAM | Parameters are not valid |
OpEN API Version: 1.19
open_error_t openapiIpv4dtProbeAutoSourceSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | host, | ||
uint32_t * | mask | ||
) |
Sets the Ipv4dt Probe Auto-Source parameters.
[in] | clientHandle | OpEN client handle |
[out] | host | Auto-source Host. |
[out] | mask | Auto-source Mask. |
OPEN_E_NONE | Auto source set is successful |
OPEN_E_FAIL | Failed to set the auto source parameters |
OPEN_E_PARAM | Parameters are not valid |
OpEN API Version: 1.19
open_error_t openapiIpv4dtProbeCountGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | count | ||
) |
Gets the Ipv4dt Probe Count.
[in] | clientHandle | OpEN client handle |
[out] | count | Probe Count. |
OPEN_E_NONE | Probe count get is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_FAIL | Failed to get the probe count |
OpEN API Version: 1.19
open_error_t openapiIpv4dtProbeCountSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | count | ||
) |
Sets the Ipv4dt Probe Count.
[in] | clientHandle | OpEN client handle |
[in] | count | Probe Count. |
OPEN_E_NONE | Probe count set is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_INTERNAL | Failed to set the probe count |
OpEN API Version: 1.19
open_error_t openapiIpv4dtProbeDelayGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | delay | ||
) |
Gets the Ipv4dt Probe Delay.
[in] | clientHandle | OpEN client handle |
[out] | delay | Probe Delay. |
OPEN_E_NONE | Probe delay get is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_FAIL | Failed to get the probe delay |
OpEN API Version: 1.19
open_error_t openapiIpv4dtProbeDelaySet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | delay | ||
) |
Sets the Ipv4dt Probe Delay.
[in] | clientHandle | OpEN client handle |
[in] | delay | Probe Delay. |
OPEN_E_NONE | Probe delay set is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_INTERNAL | Failed to set the probe delay |
OpEN API Version: 1.19
open_error_t openapiIpv4dtProbeIntervalGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | delay | ||
) |
Gets the Ipv4dt Probe Interval.
[in] | clientHandle | OpEN client handle |
[out] | interval | Probe Interval. |
OPEN_E_NONE | Probe interval get is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_FAIL | Failed to get the probe interval |
OpEN API Version: 1.19
open_error_t openapiIpv4dtProbeIntervalSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | delay | ||
) |
Sets the Ipv4dt Probe Interval.
[in] | clientHandle | OpEN client handle |
[in] | interval | Probe Interval. |
OPEN_E_NONE | Probe interval set is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_INTERNAL | Failed to set the probe interval |
OpEN API Version: 1.19
open_error_t openapiIpv4dtProbeModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | enable | ||
) |
Gets the Ipv4dt Probe mode.
[in] | clientHandle | OpEN client handle |
[out] | enable | Mode (Enable or Disable). |
OPEN_E_NONE | Probe mode get is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_FAIL | Failed to get the probe mode |
OpEN API Version: 1.19
open_error_t openapiIpv4dtProbeModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | enable | ||
) |
Sets the Ipv4dt Probe mode.
[in] | clientHandle | OpEN client handle |
[in] | enable | Mode (Enable or Disable). |
OPEN_E_NONE | Probe mode set is successful |
OPEN_E_PARAM | Parameters are not valid |
OPEN_E_FAIL | Failed to set the probe mode |
OpEN API Version: 1.19
open_error_t openapiIpv4dtTableGetNext | ( | openapiClientHandle_t * | client_handle, |
OPEN_IPV4DT_SHOW_REQUEST_t * | ipv4dtShow, | ||
OPEN_IPV4DT_ENTRY_t * | entry | ||
) |
Gets the Ipv4dt Entries.
[in] | clientHandle | OpEN client handle |
[in] | ipv4dtShow | Show request parameters |
[out] | entry | IPv4DT Entry |
OPEN_E_NONE | Next Entry get is successful |
OPEN_E_FAIL | Failed to get the next entry |
OPEN_E_PARAM | Parameters are not valid |
OpEN API Version: 1.19