Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_ping.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2018 Broadcom
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_ping.h
28 *
29 * @purpose APIs for issuing ping to a host or IPv4/IPv6 address
30 *
31 * @component OpEN
32 *
33 * @note This code must not include any ICOS header files.
34 *
35 * @create 03/29/2018
36 *
37 * @end
38 *
39 **********************************************************************/
40 #ifndef OPENAPI_PING_H_INCLUDED
41 #define OPENAPI_PING_H_INCLUDED
42 
43 #define OPEN_PING_STRING_SIZE 2048
44 #define OPEN_PING_ADDRESS_MAX_LEN 256
45 #define OPEN_PING_DEFAULT_PROBE_SIZE 0
46 #define OPEN_PING_OUT_INTF_STRING_SIZE 32
47 
48 typedef enum
49 {
53 
54 typedef enum
55 {
59 
60 /*****************************************************************/
79  open_buffdesc *address,
80  open_buffdesc *output);
81 
82 /*****************************************************************/
104  open_buffdesc *address,
105  uint32_t pingCount,
106  open_buffdesc *output);
107 
108 /*****************************************************************/
130  open_buffdesc *address,
131  uint32_t pingInterval,
132  open_buffdesc *output);
133 
134 /*****************************************************************/
156  open_buffdesc *address,
157  uint32_t pingSize,
158  open_buffdesc *output);
159 
160 /*****************************************************************/
182  open_buffdesc *address,
184  open_buffdesc *output);
185 
186 /*****************************************************************/
218  open_buffdesc *address,
219  uint32_t pingCount,
220  uint32_t pingInterval,
221  uint32_t pingSize,
223  open_buffdesc *output);
224 
225 #endif
226 
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.
OPEN_PING_SOURCE_INTF_TYPE_t
Definition: openapi_ping.h:54
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.
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.
OPEN_PING_ADDR_TYPE_t
Definition: openapi_ping.h:48
Ping IPv4 Address Type.
Definition: openapi_ping.h:50
Ping Ipv6 Address Type.
Definition: openapi_ping.h:51
open_error_t
OPEN uses these enumerators to indicate the error codes.
Ping IP Address/Hostname/IPv6 Address with source interface as network port.
Definition: openapi_ping.h:57
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.
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.
Ping IP Address/Hostname/IPv6 Address with source interface as service port.
Definition: openapi_ping.h:56
open_error_t openapiPingAddress(openapiClientHandle_t *client_handle, open_buffdesc *address, open_buffdesc *output)
Ping host or IPv4/IPv6 Address.