Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_PING_ADDRESS_MAX_LEN 256 |
#define | OPEN_PING_DEFAULT_PROBE_SIZE 0 |
#define | OPEN_PING_OUT_INTF_STRING_SIZE 32 |
#define | OPEN_PING_STRING_SIZE 2048 |
Enumerations | |
enum | OPEN_PING_ADDR_TYPE_t { OPEN_PING_ADDR_TYPE_IPV4 = 0, OPEN_PING_ADDR_TYPE_IPV6 = 1 } |
enum | OPEN_PING_SOURCE_INTF_TYPE_t { OPEN_PING_SOURCE_INTF_SERVICE_PORT = 0, OPEN_PING_SOURCE_INTF_NETWORK_PORT = 1 } |
Functions | |
open_error_t | openapiPingAddress (openapiClientHandle_t *client_handle, open_buffdesc *address, open_buffdesc *output) |
Ping host or IPv4/IPv6 Address. More... | |
open_error_t | openapiPingAddressExplicit (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t pingCount, uint32_t pingInterval, uint32_t pingSize, OPEN_PING_SOURCE_INTF_TYPE_t srcIntf, open_buffdesc *output) |
Ping host or IPv4/IPv6 Address with all parameters given at a time. More... | |
open_error_t | openapiPingAddressWithCount (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t pingCount, open_buffdesc *output) |
Ping host or IPv4/IPv6 Address with specific count. More... | |
open_error_t | openapiPingAddressWithInterval (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t pingInterval, open_buffdesc *output) |
Ping host or IPv4/IPv6 Address with specific interval. More... | |
open_error_t | openapiPingAddressWithPDUSize (openapiClientHandle_t *client_handle, open_buffdesc *address, uint32_t pingSize, open_buffdesc *output) |
Ping host or IPv4/IPv6 Address with specific probe size. More... | |
open_error_t | openapiPingAddressWithSourceInterface (openapiClientHandle_t *client_handle, open_buffdesc *address, OPEN_PING_SOURCE_INTF_TYPE_t srcIntf, open_buffdesc *output) |
Ping host or IPv4/IPv6 Address with source interface. More... | |
Enumerator | |
---|---|
OPEN_PING_ADDR_TYPE_IPV4 |
Ping IPv4 Address Type. |
OPEN_PING_ADDR_TYPE_IPV6 |
Ping Ipv6 Address Type. |
Definition at line 48 of file openapi_ping.h.
Definition at line 54 of file openapi_ping.h.
open_error_t openapiPingAddress | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
open_buffdesc * | output | ||
) |
Ping host or IPv4/IPv6 Address.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[out] | output | ping output |
OPEN_E_NONE | if ping to host or IPv4/IPv6 address is successful. |
OPEN_E_FAIL | if failed to ping host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiPingAddressExplicit | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | pingCount, | ||
uint32_t | pingInterval, | ||
uint32_t | pingSize, | ||
OPEN_PING_SOURCE_INTF_TYPE_t | srcIntf, | ||
open_buffdesc * | output | ||
) |
Ping host or IPv4/IPv6 Address with all parameters given at a time.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | pingCount | number of times to ping |
[in] | pingInterval | interval between probes in seconds |
[in] | pingSize | ping probe PDU size |
[in] | srcIntf | network port/service port |
[out] | output | ping output |
OPEN_E_NONE | if ping to host or IPv4/IPv6 address is successful. |
OPEN_E_FAIL | if failed to ping host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OPEN_E_UNAVAIL | if service port/network port is not supported for source interface |
OpEN API Version: 1.18
open_error_t openapiPingAddressWithCount | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | pingCount, | ||
open_buffdesc * | output | ||
) |
Ping host or IPv4/IPv6 Address with specific count.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | pingCount | number of times to ping |
[out] | output | ping output |
OPEN_E_NONE | if ping to host or IPv4/IPv6 address is successful. |
OPEN_E_FAIL | if failed to ping host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiPingAddressWithInterval | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | pingInterval, | ||
open_buffdesc * | output | ||
) |
Ping host or IPv4/IPv6 Address with specific interval.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | pingInterval | interval between probes in seconds |
[out] | output | ping output |
OPEN_E_NONE | if ping to host or IPv4/IPv6 address is successful. |
OPEN_E_FAIL | if failed to ping host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiPingAddressWithPDUSize | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
uint32_t | pingSize, | ||
open_buffdesc * | output | ||
) |
Ping host or IPv4/IPv6 Address with specific probe size.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | pingSize | ping probe PDU size |
[out] | output | ping output |
OPEN_E_NONE | if ping to host or IPv4/IPv6 address is successful. |
OPEN_E_FAIL | if failed to ping host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OpEN API Version: 1.18
open_error_t openapiPingAddressWithSourceInterface | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | address, | ||
OPEN_PING_SOURCE_INTF_TYPE_t | srcIntf, | ||
open_buffdesc * | output | ||
) |
Ping host or IPv4/IPv6 Address with source interface.
[in] | client_handle | Client handle from registration API |
[in] | address | host or IPv4/IPv6 Address |
[in] | srcIntf | network port/service port |
[out] | output | ping output |
OPEN_E_NONE | if ping to host or IPv4/IPv6 address is successful. |
OPEN_E_FAIL | if failed to ping host or IPv4/IPv6 address. |
OPEN_E_PARAM | if invalid parameter is passed. |
OPEN_E_UNAVAIL | if service port/network port is not supported for source interface |
OpEN API Version: 1.18