mmiperf_client_args Struct Reference

Detailed Description

Iperf client arguments data structure.

For forward compatibility this structure should be initialized using MMIPERF_CLIENT_ARGS_DEFAULT. For example:

struct mmiperf_client_args args = MMIPERF_CLIENT_ARGS_DEFAULT;

Definition at line 156 of file mmiperf.h.

#include <mmiperf.h>

Data Fields
char	server_addr [MMIPERF_IPADDR_MAXLEN]
	IP address of iperf server to communicate with (as a string). More...
uint16_t	server_port
	Port on iperf server to communicate with. More...
uint32_t	target_bw
	Bandwidth limit (in kbps) to communicate with (0 indicates no limit). More...
uint32_t	packet_size
	Packet size to use. More...
int32_t	amount
	If positive specifies how many bytes to transfer; if negative the absolute value specifies the duration of the test in hundredths of seconds. More...
mmiperf_report_fn	report_fn
	Report callback function to invoke on completion/abort. More...
void *	report_arg
	Opaque argument to pass to the report callback. More...
enum iperf_version	version
	Iperf version used to parse packet header. More...

Field Documentation

amount

int32_t mmiperf_client_args::amount

If positive specifies how many bytes to transfer; if negative the absolute value specifies the duration of the test in hundredths of seconds.

Definition at line 171 of file mmiperf.h.

packet_size

uint32_t mmiperf_client_args::packet_size

Packet size to use.

Only applies to UDP iperf tests. When set to zero, appropriate value of MMIPERF_DEFAULT_UDP_PACKET_SIZE_V4 or MMIPERF_DEFAULT_UDP_PACKET_SIZE_V6 will be used depending on whether the given server_addr is IPv4 or IPv6 address.

Definition at line 168 of file mmiperf.h.

report_arg

void* mmiperf_client_args::report_arg

Opaque argument to pass to the report callback.

May be NULL.

Definition at line 175 of file mmiperf.h.

report_fn

mmiperf_report_fn mmiperf_client_args::report_fn

Report callback function to invoke on completion/abort.

May be NULL.

Definition at line 173 of file mmiperf.h.

server_addr

char mmiperf_client_args::server_addr[MMIPERF_IPADDR_MAXLEN]

IP address of iperf server to communicate with (as a string).

Definition at line 159 of file mmiperf.h.

server_port

uint16_t mmiperf_client_args::server_port

Port on iperf server to communicate with.

Definition at line 161 of file mmiperf.h.

target_bw

uint32_t mmiperf_client_args::target_bw

Bandwidth limit (in kbps) to communicate with (0 indicates no limit).

Definition at line 163 of file mmiperf.h.

version

enum iperf_version mmiperf_client_args::version

Iperf version used to parse packet header.

Definition at line 177 of file mmiperf.h.

---

The documentation for this struct was generated from the following file:

• mmiperf.h