openapi_ping.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_ping.h
*
* @purpose   APIs for issuing ping to a host or IPv4/IPv6 address
*
* @component OpEN
*
* @note  This code must not include any ICOS header files.
*
* @create    03/29/2018
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_PING_H_INCLUDED
#define OPENAPI_PING_H_INCLUDED

#define OPEN_PING_STRING_SIZE           2048
#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_CALLBACK_STR_MAX_LEN  256

typedef enum
{
  OPEN_PING_ADDR_TYPE_IPV4 = 0,  
  OPEN_PING_ADDR_TYPE_IPV6 = 1,  
  OPEN_PING_ADDR_TYPE_NONE = 2   
}OPEN_PING_ADDR_TYPE_t;

typedef enum
{
 OPEN_PING_SOURCE_INTF_SERVICE_PORT = 0,  
 OPEN_PING_SOURCE_INTF_NETWORK_PORT = 1   
}OPEN_PING_SOURCE_INTF_TYPE_t;

typedef enum
{
 OPEN_PING_SOURCE_SERVICE_PORT = 0,  
 OPEN_PING_SOURCE_NETWORK_PORT = 1,  
 OPEN_PING_SOURCE_IP_PORT      = 2,  
 OPEN_PING_SOURCE_ADDRESS      = 3,  
 OPEN_PING_SOURCE_NONE         = 4   
}OPEN_PING_SOURCE_TYPE_t;

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

/*****************************************************************/
open_error_t openapiPingAddressWithCount (openapiClientHandle_t *client_handle,
                                          open_buffdesc *address,
                                          uint32_t pingCount,
                                          open_buffdesc *output);

/*****************************************************************/
open_error_t openapiPingAddressWithInterval(openapiClientHandle_t *client_handle,
                                            open_buffdesc *address,
                                            uint32_t pingInterval,
                                            open_buffdesc *output);

/*****************************************************************/
open_error_t openapiPingAddressWithPDUSize(openapiClientHandle_t *client_handle,
                                           open_buffdesc *address,
                                           uint32_t pingSize,
                                           open_buffdesc *output);

/*****************************************************************/
open_error_t openapiPingAddressWithSourceInterface(openapiClientHandle_t *client_handle,
                                                   open_buffdesc *address,
                                                   OPEN_PING_SOURCE_INTF_TYPE_t srcIntf,
                                                   open_buffdesc *output);

/*****************************************************************/
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);

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

/*****************************************************************/
open_error_t openapiPing (openapiClientHandle_t *client_handle,
                          open_buffdesc *vrfName,
                          OPEN_AF_t family,
                          open_buffdesc *address,
                          uint32_t pingCount,
                          uint32_t pingInterval,
                          uint32_t pingSize,
                          OPEN_PING_SOURCE_TYPE_t srcType,
                          uint32_t intIfNum,
                          open_buffdesc *srcAddr,
                          open_buffdesc *output);

#endif