fnet_ping.h

/**************************************************************************
*
* Copyright 2011-2018 by Andrey Butok. FNET Community.
*
***************************************************************************
*
*  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.
*
***************************************************************************
*
* PING API.
*
***************************************************************************/

#ifndef _FNET_PING_H_

#define _FNET_PING_H_

#if FNET_CFG_PING || defined(__DOXYGEN__)

/**************************************************************************/ 
typedef void(*fnet_ping_callback_t)(fnet_error_t result, fnet_size_t packet_count, struct fnet_sockaddr *target_addr, void *cookie);

/**************************************************************************/ 
typedef struct
{
    struct fnet_sockaddr    target_addr;    
    fnet_size_t             packet_size;    
    fnet_size_t             packet_count;   
    fnet_time_t             timeout;        
    fnet_uint8_t            ttl;            
    fnet_uint8_t            pattern;        
    fnet_ping_callback_t    callback;      
    void                    *cookie;        
} fnet_ping_params_t;

#if defined(__cplusplus)
extern "C" {
#endif

/***************************************************************************/ 
fnet_return_t fnet_ping_init( fnet_ping_params_t *params );

/***************************************************************************/ 
void fnet_ping_release(void);

#if defined(__cplusplus)
}
#endif

#endif /* FNET_CFG_PING */

#endif /* _FNET_PING_H_ */