Embedded TCP/IP stack: fnet_bench_cln.h Source File

FNET

previous page next page
fnet_bench_cln.h
1 /**************************************************************************
2 *
3 * Copyright 2018 by Andrey Butok. FNET Community.
4 *
5 ***************************************************************************
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 ***************************************************************************
20 *
21 * FNET benchmark client API.
22 *
23 ***************************************************************************/
24 
25 #ifndef _FNET_BENCH_CLN_H_
26 
27 #define _FNET_BENCH_CLN_H_
28 
29 #if FNET_CFG_BENCH_CLN || defined(__DOXYGEN__)
30 
56 /**************************************************************************/
60 typedef void* fnet_bench_cln_desc_t;
61 
62 /**************************************************************************/
66 struct fnet_bench_cln_result
67 {
68  fnet_size_t megabytes;
69  fnet_size_t bytes;
70  fnet_time_t time_ms;
71 };
72 
73 /**************************************************************************/
82 typedef void(*fnet_bench_cln_callback_session_end_t)(fnet_bench_cln_desc_t bench_cln_desc, const struct fnet_bench_cln_result *bench_cln_result, void *cookie);
83 
84 /**************************************************************************/
87 struct fnet_bench_cln_params
88 {
89  struct fnet_sockaddr address;
90  fnet_socket_type_t type;
91  fnet_size_t message_size;
92  fnet_index_t message_number;
93  fnet_bench_cln_callback_session_end_t callback;
96  void *cookie;
99 };
100 
101 #if defined(__cplusplus)
102 extern "C" {
103 #endif
104 
105 /***************************************************************************/
131 fnet_bench_cln_desc_t fnet_bench_cln_init( struct fnet_bench_cln_params *params );
132 
133 /***************************************************************************/
150 void fnet_bench_cln_release(fnet_bench_cln_desc_t desc);
151 
152 /***************************************************************************/
167 fnet_bool_t fnet_bench_cln_is_enabled(fnet_bench_cln_desc_t desc);
168 
169 #if defined(__cplusplus)
170 }
171 #endif
172 
175 #endif /* FNET_CFG_BENCH_CLN */
176 
177 #endif /* _FNET_BENCH_CLN_H_ */
fnet_bench_cln_result::bytes
fnet_size_t bytes
Number of transmitted bytes, in addition to megabytes, during the benchmark session.
Definition: fnet_bench_cln.h:69
fnet_bench_cln_params::callback
fnet_bench_cln_callback_session_end_t callback
Pointer to the callback function defined by fnet_bench_cln_callback_session_end_t. It is called when the benchmark session is finished.
Definition: fnet_bench_cln.h:93
fnet_bench_cln_result
Benchmark client result passed to the "session end" event handler callback.
Definition: fnet_bench_cln.h:66
fnet_bench_cln_is_enabled
fnet_bool_t fnet_bench_cln_is_enabled(fnet_bench_cln_desc_t desc)
Detects if the Benchmark client service is enabled or disabled.
fnet_time_t
fnet_uint32_t fnet_time_t
Unsigned integer type representing time uinits. It can be ticks, seconds or milliseconds.
Definition: fnet_timer.h:66
fnet_bench_cln_desc_t
void * fnet_bench_cln_desc_t
Benchmark client descriptor.
Definition: fnet_bench_cln.h:60
fnet_bench_cln_init
fnet_bench_cln_desc_t fnet_bench_cln_init(struct fnet_bench_cln_params *params)
Initializes the Benchmark client service and starts the benchmark session.
fnet_size_t
unsigned long fnet_size_t
Unsigned integer type representing the size in bytes.
Definition: fnet_stdlib.h:56
fnet_bench_cln_result::megabytes
fnet_size_t megabytes
Number of transmitted megabytes during the benchmark session.
Definition: fnet_bench_cln.h:68
fnet_bool_t
fnet_bool_t
Boolean type.
Definition: fnet_stdlib.h:81
fnet_bench_cln_params::message_size
fnet_size_t message_size
Size of one message to send. Its value must be less than FNET_CFG_BENCH_CLN_BUFFER_SIZE.
Definition: fnet_bench_cln.h:91
fnet_bench_cln_result::time_ms
fnet_time_t time_ms
Benchmark session lifetime in milliseconds.
Definition: fnet_bench_cln.h:70
fnet_socket_type_t
fnet_socket_type_t
Socket types.
Definition: fnet_socket.h:319
fnet_bench_cln_params::message_number
fnet_index_t message_number
Number of messages to send.
Definition: fnet_bench_cln.h:92
fnet_index_t
unsigned int fnet_index_t
Unsigned integer type representing the index.
Definition: fnet_stdlib.h:71
fnet_bench_cln_release
void fnet_bench_cln_release(fnet_bench_cln_desc_t desc)
Aborts the benchmark session and releases the benchmark client service.
fnet_bench_cln_params::type
fnet_socket_type_t type
Protocol type. It can be SOCK_STREAM (TCP) or SOCK_DGRAM (UDP).
Definition: fnet_bench_cln.h:90
fnet_bench_cln_params::cookie
void * cookie
Optional application-specific parameter. It's passed to the callback function as input parameter...
Definition: fnet_bench_cln.h:96
fnet_bench_cln_params
Initialization parameters for the fnet_bench_cln_init() function.
Definition: fnet_bench_cln.h:87
fnet_sockaddr
Socket address structure.
Definition: fnet_socket.h:270
fnet_bench_cln_callback_session_end_t
void(* fnet_bench_cln_callback_session_end_t)(fnet_bench_cln_desc_t bench_cln_desc, const struct fnet_bench_cln_result *bench_cln_result, void *cookie)
Benchmark client event handler callback function prototype, that is called when the benchmark client ...
Definition: fnet_bench_cln.h:82
© 2005-2018 by Andrey Butok. http://fnet.sourceforge.net
previous page start next page