ping configuration variables

Detailed Description

Functions
static enum mmagic_status	mmagic_controller_get_ping_target (struct mmagic_controller *controller, struct struct_ip_addr *var)
	Gets target setting for module ping. More...
static enum mmagic_status	mmagic_controller_set_ping_target (struct mmagic_controller *controller, struct struct_ip_addr *var)
	Sets target setting for module ping. More...
static enum mmagic_status	mmagic_controller_get_ping_interval (struct mmagic_controller *controller, uint32_t *var)
	Gets interval setting for module ping. More...
static enum mmagic_status	mmagic_controller_set_ping_interval (struct mmagic_controller *controller, uint32_t var)
	Sets interval setting for module ping. More...
static enum mmagic_status	mmagic_controller_get_ping_count (struct mmagic_controller *controller, uint32_t *var)
	Gets count setting for module ping. More...
static enum mmagic_status	mmagic_controller_set_ping_count (struct mmagic_controller *controller, uint32_t var)
	Sets count setting for module ping. More...
static enum mmagic_status	mmagic_controller_ping_commit_all (struct mmagic_controller *controller)
	Saves all settings from persistent store. More...

Function Documentation

mmagic_controller_get_ping_count()

static enum mmagic_status mmagic_controller_get_ping_count ( struct mmagic_controller *  controller, uint32_t *  var  )

inlinestatic

Gets count setting for module ping.

This specifies the number of ping requests to send before terminating the session. If this is zero or exceeds UINT16_MAX (65535) then it it will be set to UINT16_MAX.

Parameters

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

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4248 of file mmagic_controller.h.

mmagic_controller_get_ping_interval()

static enum mmagic_status mmagic_controller_get_ping_interval ( struct mmagic_controller *  controller, uint32_t *  var  )

inlinestatic

Gets interval setting for module ping.

The time interval between ping requests (in milliseconds).

Parameters

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

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4195 of file mmagic_controller.h.

mmagic_controller_get_ping_target()

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

inlinestatic

Gets target setting for module ping.

The IP address of the ping target.

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 4143 of file mmagic_controller.h.

mmagic_controller_ping_commit_all()

static enum mmagic_status mmagic_controller_ping_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 4298 of file mmagic_controller.h.

mmagic_controller_set_ping_count()

static enum mmagic_status mmagic_controller_set_ping_count ( struct mmagic_controller *  controller, uint32_t  var  )

inlinestatic

Sets count setting for module ping.

This specifies the number of ping requests to send before terminating the session. If this is zero or exceeds UINT16_MAX (65535) then it it will be set to UINT16_MAX.

Parameters

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

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4275 of file mmagic_controller.h.

mmagic_controller_set_ping_interval()

static enum mmagic_status mmagic_controller_set_ping_interval ( struct mmagic_controller *  controller, uint32_t  var  )

inlinestatic

Sets interval setting for module ping.

The time interval between ping requests (in milliseconds).

Parameters

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

Returns

MMAGIC_STATUS_OK on success, else an error code.

Definition at line 4221 of file mmagic_controller.h.

mmagic_controller_set_ping_target()

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

inlinestatic

Sets target setting for module ping.

The IP address of the ping target.

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 4169 of file mmagic_controller.h.