Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_traceroute.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_traceroute.h
28 *
29 * @purpose APIs to traceroute 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_TRACEROUTE_H_INCLUDED
41 #define OPENAPI_TRACEROUTE_H_INCLUDED
42 
43 #define OPEN_TRACEROUTE_STRING_SIZE 1024
44 #define OPEN_TRACEROUTE_OUTPUT_STRING_SIZE 4096
45 #define OPEN_TRACEROUTE_ADDRESS_MAX_LEN 256
46 #define OPEN_TRACEROUTE_DEFAULT_PROBE_SIZE 0
47 #define OPEN_TRACEROUTE_DEFAULT_MAX_TTL 30
48 
49 
50 typedef enum
51 {
52  OPEN_TRACEROUTE_ADDR_TYPE_IPV4 = 0,
53  OPEN_TRACEROUTE_ADDR_TYPE_IPV6 = 1
54 }OPEN_TRACEROUTE_ADDR_TYPE_t;
55 
56 typedef enum
57 {
58  OPEN_TRACEROUTE_SOURCE_INTF_SERVICE_PORT = 0,
59  OPEN_TRACEROUTE_SOURCE_INTF_NETWORK_PORT = 1
60 }OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t;
61 
62 /***************************************************************************/
80 open_error_t openapiTracerouteAddress(openapiClientHandle_t *client_handle,
81  open_buffdesc *address,
82  open_buffdesc *output);
83 
84 /***************************************************************************/
105 open_error_t openapiTracerouteAddressWithCount(openapiClientHandle_t *client_handle,
106  open_buffdesc *address,
107  uint32_t tracerouteCount,
108  open_buffdesc *output);
109 
110 /***************************************************************************/
131 open_error_t openapiTracerouteAddressWithInterval(openapiClientHandle_t *client_handle,
132  open_buffdesc *address,
133  uint32_t tracerouteInterval,
134  open_buffdesc *output);
135 
136 /***************************************************************************/
160 open_error_t openapiTracerouteAddressWithTtl(openapiClientHandle_t *client_handle,
161  open_buffdesc *address,
162  uint32_t tracerouteInitTtl,
163  uint32_t tracerouteMaxTtl,
164  open_buffdesc *output);
165 
166 /***************************************************************************/
187 open_error_t openapiTracerouteAddressWithMaxFail(openapiClientHandle_t *client_handle,
188  open_buffdesc *address,
189  uint32_t tracerouteMaxFail,
190  open_buffdesc *output);
191 
192 /***************************************************************************/
213 open_error_t openapiTracerouteAddressWithPDUSize(openapiClientHandle_t *client_handle,
214  open_buffdesc *address,
215  uint32_t tracerouteSize,
216  open_buffdesc *output);
217 
218 /***************************************************************************/
239 open_error_t openapiTracerouteAddressWithUdpPort(openapiClientHandle_t *client_handle,
240  open_buffdesc *address,
241  uint32_t tracerouteUdpPort,
242  open_buffdesc *output);
243 
244 /***************************************************************************/
266 open_error_t openapiTracerouteAddressWithSourceInterface(openapiClientHandle_t *client_handle,
267  open_buffdesc *address,
268  OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t srcIntf,
269  open_buffdesc *output);
270 
271 /***************************************************************************/
314 open_error_t openapiTracerouteAddressExplicit(openapiClientHandle_t *client_handle,
315  open_buffdesc *address,
316  uint32_t tracerouteCount,
317  uint32_t tracerouteInterval,
318  uint32_t tracerouteInitTtl,
319  uint32_t tracerouteMaxTtl,
320  uint32_t tracerouteMaxFail,
321  uint32_t tracerouteSize,
322  uint32_t tracerouteUdpPort,
323  OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t srcIntf,
324  open_buffdesc *output);
325 #endif
326