iperf configuration variables

Detailed Description

Functions
static enum mmagic_status	mmagic_controller_get_iperf_mode (struct mmagic_controller *controller, enum mmagic_iperf_mode *var)
	Gets mode setting for module iperf. More...
static enum mmagic_status	mmagic_controller_set_iperf_mode (struct mmagic_controller *controller, enum mmagic_iperf_mode var)
	Sets mode setting for module iperf. More...
static enum mmagic_status	mmagic_controller_get_iperf_server (struct mmagic_controller *controller, struct struct_ip_addr *var)
	Gets server setting for module iperf. More...
static enum mmagic_status	mmagic_controller_set_iperf_server (struct mmagic_controller *controller, struct struct_ip_addr *var)
	Sets server setting for module iperf. More...
static enum mmagic_status	mmagic_controller_get_iperf_port (struct mmagic_controller *controller, uint16_t *var)
	Gets port setting for module iperf. More...
static enum mmagic_status	mmagic_controller_set_iperf_port (struct mmagic_controller *controller, uint16_t var)
	Sets port setting for module iperf. More...
static enum mmagic_status	mmagic_controller_get_iperf_amount (struct mmagic_controller *controller, int32_t *var)
	Gets amount setting for module iperf. More...
static enum mmagic_status	mmagic_controller_set_iperf_amount (struct mmagic_controller *controller, int32_t var)
	Sets amount setting for module iperf. More...
static enum mmagic_status	mmagic_controller_iperf_commit_all (struct mmagic_controller *controller)
	Saves all settings from persistent store. More...

Function Documentation

mmagic_controller_get_iperf_amount()

static enum mmagic_status mmagic_controller_get_iperf_amount ( struct mmagic_controller *  controller, int32_t *  var  )

inlinestatic

Gets amount setting for module iperf.

This specifies the duration for client transfers specified either in seconds or bytes. If this is negative, it specifies a time in seconds; if positive, it specifies the number of bytes to transmit.

Parameters

controller	Reference to the controller handle.
var	Reference to the int32_t to place the received data in.

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4535 of file mmagic_controller.h.

mmagic_controller_get_iperf_mode()

static enum mmagic_status mmagic_controller_get_iperf_mode ( struct mmagic_controller *  controller, enum mmagic_iperf_mode *  var  )

inlinestatic

Gets mode setting for module iperf.

The iperf mode to use. Valid values are udp_server, tcp_server, udp_client and tcp_client. If not set, defaults to udp_server.

Parameters

controller	Reference to the controller handle.
var	Reference to the enum_iperf_mode to place the received data in.

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4374 of file mmagic_controller.h.

mmagic_controller_get_iperf_port()

static enum mmagic_status mmagic_controller_get_iperf_port ( struct mmagic_controller *  controller, uint16_t *  var  )

inlinestatic

Gets port setting for module iperf.

Specifies the local port to listen on when in server mode or the server port to send data to when in client mode.

Parameters

controller	Reference to the controller handle.
var	Reference to the uint16_t to place the received data in.

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4480 of file mmagic_controller.h.

mmagic_controller_get_iperf_server()

static enum mmagic_status mmagic_controller_get_iperf_server ( struct mmagic_controller *  controller, struct struct_ip_addr *  var  )

inlinestatic

Gets server setting for module iperf.

IP address of server to connect to when in client mode.

Parameters

controller	Reference to the controller handle.
var	Reference to the struct_ip_addr to place the received data in.

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4427 of file mmagic_controller.h.

mmagic_controller_iperf_commit_all()

static enum mmagic_status mmagic_controller_iperf_commit_all ( struct mmagic_controller *  controller )

inlinestatic

Saves all settings from persistent store.

Parameters

controller

Reference to the controller handle.

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4586 of file mmagic_controller.h.

mmagic_controller_set_iperf_amount()

static enum mmagic_status mmagic_controller_set_iperf_amount ( struct mmagic_controller *  controller, int32_t  var  )

inlinestatic

Sets amount setting for module iperf.

This specifies the duration for client transfers specified either in seconds or bytes. If this is negative, it specifies a time in seconds; if positive, it specifies the number of bytes to transmit.

Parameters

controller	Reference to the controller handle.
var	The int32_t to write.

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4563 of file mmagic_controller.h.

mmagic_controller_set_iperf_mode()

static enum mmagic_status mmagic_controller_set_iperf_mode ( struct mmagic_controller *  controller, enum mmagic_iperf_mode  var  )

inlinestatic

Sets mode setting for module iperf.

The iperf mode to use. Valid values are udp_server, tcp_server, udp_client and tcp_client. If not set, defaults to udp_server.

Parameters

controller	Reference to the controller handle.
var	The enum_iperf_mode to write.

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4401 of file mmagic_controller.h.

mmagic_controller_set_iperf_port()

static enum mmagic_status mmagic_controller_set_iperf_port ( struct mmagic_controller *  controller, uint16_t  var  )

inlinestatic

Sets port setting for module iperf.

Specifies the local port to listen on when in server mode or the server port to send data to when in client mode.

Parameters

controller	Reference to the controller handle.
var	The uint16_t to write.

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4507 of file mmagic_controller.h.

mmagic_controller_set_iperf_server()

static enum mmagic_status mmagic_controller_set_iperf_server ( struct mmagic_controller *  controller, struct struct_ip_addr *  var  )

inlinestatic

Sets server setting for module iperf.

IP address of server to connect to when in client mode.

Parameters

controller	Reference to the controller handle.
var	Reference to the struct_ip_addr to write.

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4453 of file mmagic_controller.h.