Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
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 {
50  OPEN_PING_ADDR_TYPE_IPV4 = 0,
51  OPEN_PING_ADDR_TYPE_IPV6 = 1
52 }OPEN_PING_ADDR_TYPE_t;
53 
54 typedef enum
55 {
56  OPEN_PING_SOURCE_INTF_SERVICE_PORT = 0,
57  OPEN_PING_SOURCE_INTF_NETWORK_PORT = 1
58 }OPEN_PING_SOURCE_INTF_TYPE_t;
59 
60 /*****************************************************************/
78 open_error_t openapiPingAddress(openapiClientHandle_t *client_handle,
79  open_buffdesc *address,
80  open_buffdesc *output);
81 
82 /*****************************************************************/
103 open_error_t openapiPingAddressWithCount (openapiClientHandle_t *client_handle,
104  open_buffdesc *address,
105  uint32_t pingCount,
106  open_buffdesc *output);
107 
108 /*****************************************************************/
129 open_error_t openapiPingAddressWithInterval(openapiClientHandle_t *client_handle,
130  open_buffdesc *address,
131  uint32_t pingInterval,
132  open_buffdesc *output);
133 
134 /*****************************************************************/
155 open_error_t openapiPingAddressWithPDUSize(openapiClientHandle_t *client_handle,
156  open_buffdesc *address,
157  uint32_t pingSize,
158  open_buffdesc *output);
159 
160 /*****************************************************************/
181 open_error_t openapiPingAddressWithSourceInterface(openapiClientHandle_t *client_handle,
182  open_buffdesc *address,
183  OPEN_PING_SOURCE_INTF_TYPE_t srcIntf,
184  open_buffdesc *output);
185 
186 /*****************************************************************/
217 open_error_t openapiPingAddressExplicit(openapiClientHandle_t *client_handle,
218  open_buffdesc *address,
219  uint32_t pingCount,
220  uint32_t pingInterval,
221  uint32_t pingSize,
222  OPEN_PING_SOURCE_INTF_TYPE_t srcIntf,
223  open_buffdesc *output);
224 
225 #endif
226