Detailed Description

Arguments data structure for TCP keep-alive arguments.

This structure should be initialized using MMWLAN_TCP_KEEPALIVE_OFFLOAD_ARGS_INIT for sensible default values, particularly for forward compatibility with new releases that may add new fields to the struct. For example:

struct mmwlan_tcp_keepalive_offload_args args = MMWLAN_TCP_KEEPALIVE_OFFLOAD_ARGS_INIT;

MMWLAN_TCP_KEEPALIVE_OFFLOAD_ARGS_INIT

#define MMWLAN_TCP_KEEPALIVE_OFFLOAD_ARGS_INIT

Initializer for mmwlan_tcp_keepalive_offload_args.

Definition: mmwlan.h:1666

mmwlan_tcp_keepalive_offload_args

Arguments data structure for TCP keep-alive arguments.

Definition: mmwlan.h:1624

Definition at line 1623 of file mmwlan.h.

#include <mmwlan.h>

Data Fields
uint8_t	set_cfgs
	A bitmap specifying which configs to set. More...

uint16_t	period_s
	The interval in seconds to send the keep alive in. More...

uint8_t	retry_count
	Number of times to retry before giving up. More...

uint8_t	retry_interval_s
	The time to wait between retries in seconds. More...

uint32_t	src_ip
	The source IP for the keep alive packet. More...

uint16_t	src_port
	The source port for the keep alive packet. More...

uint32_t	dest_ip
	The destination IP for the keep alive packet. More...

uint16_t	dest_port
	The destination port for the keep alive packet. More...

Field Documentation

◆ dest_ip

uint32_t mmwlan_tcp_keepalive_offload_args::dest_ip

The destination IP for the keep alive packet.

MMWLAN_TCP_KEEPALIVE_SET_CFG_DEST_IP_ADDR bit in set_cfgs must be set if specifying this parameter

Definition at line 1654 of file mmwlan.h.

◆ dest_port

uint16_t mmwlan_tcp_keepalive_offload_args::dest_port

The destination port for the keep alive packet.

MMWLAN_TCP_KEEPALIVE_SET_CFG_SRC_PORT bit in set_cfgs must be set if specifying this parameter

Definition at line 1658 of file mmwlan.h.

◆ period_s

uint16_t mmwlan_tcp_keepalive_offload_args::period_s

The interval in seconds to send the keep alive in.

MMWLAN_TCP_KEEPALIVE_SET_CFG_PERIOD bit in set_cfgs must be set if specifying this parameter

Definition at line 1634 of file mmwlan.h.

◆ retry_count

uint8_t mmwlan_tcp_keepalive_offload_args::retry_count

Number of times to retry before giving up.

MMWLAN_TCP_KEEPALIVE_SET_CFG_RETRY_COUNT bit in set_cfgs must be set if specifying this parameter

Definition at line 1638 of file mmwlan.h.

◆ retry_interval_s

uint8_t mmwlan_tcp_keepalive_offload_args::retry_interval_s

The time to wait between retries in seconds.

MMWLAN_TCP_KEEPALIVE_SET_CFG_RETRY_INTERVAL bit in set_cfgs must be set if specifying this parameter

Definition at line 1642 of file mmwlan.h.

◆ set_cfgs

uint8_t mmwlan_tcp_keepalive_offload_args::set_cfgs

A bitmap specifying which configs to set.

See mmwlan_tcp_keepalive_offload_cfg for values.

Definition at line 1629 of file mmwlan.h.

◆ src_ip

uint32_t mmwlan_tcp_keepalive_offload_args::src_ip

The source IP for the keep alive packet.

MMWLAN_TCP_KEEPALIVE_SET_CFG_SRC_IP_ADDR bit in set_cfgs must be set if specifying this parameter

Definition at line 1646 of file mmwlan.h.

◆ src_port

uint16_t mmwlan_tcp_keepalive_offload_args::src_port

The source port for the keep alive packet.