fnet_bench_cln.h

/**************************************************************************
*
* Copyright 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.
*
***************************************************************************
*
*  FNET benchmark client API.
*
***************************************************************************/

#ifndef _FNET_BENCH_CLN_H_

#define _FNET_BENCH_CLN_H_

#if FNET_CFG_BENCH_CLN || defined(__DOXYGEN__)

/**************************************************************************/ 
typedef void *fnet_bench_cln_desc_t;

/**************************************************************************/ 
typedef struct
{
    fnet_size_t megabytes;              
    fnet_size_t bytes;                  
    fnet_time_t time_ms;                
} fnet_bench_cln_result_t;

/**************************************************************************/ 
typedef void(*fnet_bench_cln_callback_session_end_t)(fnet_bench_cln_desc_t bench_cln_desc, const fnet_bench_cln_result_t *bench_cln_result, void *cookie);

/**************************************************************************/ 
typedef struct
{
    struct fnet_sockaddr                    address;            
    fnet_socket_type_t                      type;               
    fnet_size_t                             message_size;       
    fnet_index_t                            message_number;     
    fnet_bench_cln_callback_session_end_t   callback;           
    void                                    *cookie;            
} fnet_bench_cln_params_t;

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

/***************************************************************************/ 
fnet_bench_cln_desc_t fnet_bench_cln_init( fnet_bench_cln_params_t *params );

/***************************************************************************/ 
void fnet_bench_cln_release(fnet_bench_cln_desc_t desc);

/***************************************************************************/ 
fnet_bool_t fnet_bench_cln_is_enabled(fnet_bench_cln_desc_t desc);

#if defined(__cplusplus)
}
#endif

#endif /* FNET_CFG_BENCH_CLN */

#endif /* _FNET_BENCH_CLN_H_ */