openapi_traceroute.h

Go to the documentation of this file.

/*********************************************************************
*
*  Copyright 2018 Broadcom
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_traceroute.h
*
* @purpose   APIs to traceroute host or IPv4/IPv6 Address
*
* @component OpEN
*
* @note  This code must not include any ICOS header files.
*
* @create    03/29/2018
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_TRACEROUTE_H_INCLUDED
#define OPENAPI_TRACEROUTE_H_INCLUDED

#define OPEN_TRACEROUTE_STRING_SIZE            1024
#define OPEN_TRACEROUTE_OUTPUT_STRING_SIZE     4096
#define OPEN_TRACEROUTE_ADDRESS_MAX_LEN        256
#define OPEN_TRACEROUTE_DEFAULT_PROBE_SIZE     0
#define OPEN_TRACEROUTE_DEFAULT_MAX_TTL        30
#define OPEN_TRACEROUTE_RESP_STR_MAX_LEN       256
#define OPEN_TRACEROUTE_NUM_PROBE_PACKETS      3


typedef enum
{
  OPEN_TRACEROUTE_ADDR_TYPE_IPV4 = 0,  
  OPEN_TRACEROUTE_ADDR_TYPE_IPV6 = 1,  
  OPEN_TRACEROUTE_ADDR_TYPE_NONE = 2   
}OPEN_TRACEROUTE_ADDR_TYPE_t;

typedef enum
{
 OPEN_TRACEROUTE_SOURCE_INTF_SERVICE_PORT = 0, 
 OPEN_TRACEROUTE_SOURCE_INTF_NETWORK_PORT = 1  
}OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t;

typedef enum
{
 OPEN_TRACEROUTE_SOURCE_SERVICE_PORT = 0,  
 OPEN_TRACEROUTE_SOURCE_NETWORK_PORT = 1,  
 OPEN_TRACEROUTE_SOURCE_IP_PORT      = 2,  
 OPEN_TRACEROUTE_SOURCE_ADDRESS      = 3,  
 OPEN_TRACEROUTE_SOURCE_NONE         = 4   
}OPEN_TRACEROUTE_SOURCE_TYPE_t;

/***************************************************************************/
open_error_t openapiTracerouteAddress(openapiClientHandle_t *client_handle,
                                      open_buffdesc *address,
                                      open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTracerouteAddressWithCount(openapiClientHandle_t *client_handle,
                                               open_buffdesc *address,
                                               uint32_t tracerouteCount,
                                               open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTracerouteAddressWithInterval(openapiClientHandle_t *client_handle,
                                                  open_buffdesc *address,
                                                  uint32_t tracerouteInterval,
                                                  open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTracerouteAddressWithTtl(openapiClientHandle_t *client_handle,
                                             open_buffdesc *address,
                                             uint32_t tracerouteInitTtl,
                                             uint32_t tracerouteMaxTtl,
                                             open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTracerouteAddressWithMaxFail(openapiClientHandle_t *client_handle,
                                                 open_buffdesc *address,
                                                 uint32_t tracerouteMaxFail,
                                                 open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTracerouteAddressWithPDUSize(openapiClientHandle_t *client_handle,
                                                 open_buffdesc *address,
                                                 uint32_t tracerouteSize,
                                                 open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTracerouteAddressWithUdpPort(openapiClientHandle_t *client_handle,
                                                 open_buffdesc *address,
                                                 uint32_t tracerouteUdpPort,
                                                 open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTracerouteAddressWithSourceInterface(openapiClientHandle_t *client_handle,
                                                         open_buffdesc *address,
                                                         OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t srcIntf,
                                                         open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTracerouteAddressExplicit(openapiClientHandle_t *client_handle,
                                              open_buffdesc *address,
                                              uint32_t tracerouteCount,
                                              uint32_t tracerouteInterval,
                                              uint32_t tracerouteInitTtl,
                                              uint32_t tracerouteMaxTtl,
                                              uint32_t tracerouteMaxFail,
                                              uint32_t tracerouteSize,
                                              uint32_t tracerouteUdpPort,
                                              OPEN_TRACEROUTE_SOURCE_INTF_TYPE_t srcIntf,
                                              open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTracerouteWithSource (openapiClientHandle_t *client_handle,
                                          open_buffdesc *vrfName,
                                          OPEN_AF_t family,
                                          open_buffdesc *address,
                                          OPEN_TRACEROUTE_SOURCE_TYPE_t srcType,
                                          uint32_t srcIntf,
                                          open_buffdesc *srcAddr,
                                          open_buffdesc *output);

/***************************************************************************/
open_error_t openapiTraceroute (openapiClientHandle_t *client_handle,
                                open_buffdesc *vrfName,
                                OPEN_AF_t family,
                                open_buffdesc *address,
                                uint32_t tracerouteCount,
                                uint32_t tracerouteInterval,
                                uint32_t tracerouteInitTtl,
                                uint32_t tracerouteMaxTtl,
                                uint32_t tracerouteMaxFail,
                                uint32_t tracerouteSize,
                                uint32_t tracerouteUdpPort,
                                OPEN_TRACEROUTE_SOURCE_TYPE_t srcType,
                                uint32_t srcIntf,
                                open_buffdesc *srcAddr,
                                open_buffdesc *output);
#endif