Compile-time configuration options for Asymcute, an asynchronous MQTT-SN implementation based on the OASIS MQTT-SN protocol. More...

Detailed Description

Compile-time configuration options for Asymcute, an asynchronous MQTT-SN implementation based on the OASIS MQTT-SN protocol.

It provides a flexible interface that allows users to issue any number of concurrent requests to one or more different gateways simultaneously.

Macros
#define	CONFIG_ASYMCUTE_DEFAULT_PORT (1883U)
	Default UDP port to listen on.

#define	CONFIG_ASYMCUTE_BUFSIZE (128U)
	Default buffer size used for receive and request buffers.

#define	CONFIG_ASYMCUTE_TOPIC_MAXLEN (32U)
	Maximum topic length.

#define	CONFIG_ASYMCUTE_KEEPALIVE (360)
	Keep alive interval [in s] communicated to the gateway.

#define	CONFIG_ASYMCUTE_KEEPALIVE_PING ((CONFIG_ASYMCUTE_KEEPALIVE / 4) * 3)
	Interval to use for sending periodic ping messages.

#define	CONFIG_ASYMCUTE_T_RETRY (10U)
	Resend interval [in seconds].

#define	CONFIG_ASYMCUTE_N_RETRY (3U)
	Number of retransmissions until requests time out.

Macro Definition Documentation

◆ CONFIG_ASYMCUTE_BUFSIZE

#define CONFIG_ASYMCUTE_BUFSIZE (128U)

Default buffer size used for receive and request buffers.

Definition at line 85 of file asymcute.h.

◆ CONFIG_ASYMCUTE_DEFAULT_PORT

#define CONFIG_ASYMCUTE_DEFAULT_PORT (1883U)

Default UDP port to listen on.

Usage can be found in examples/asymcute_mqttsn. Application code is expected to use this macro to assign the default port.

Definition at line 78 of file asymcute.h.

◆ CONFIG_ASYMCUTE_KEEPALIVE

#define CONFIG_ASYMCUTE_KEEPALIVE (360)

Keep alive interval [in s] communicated to the gateway.

Keep alive interval in seconds which is communicated to the gateway in the CONNECT message. For more information, see MQTT-SN Spec v1.2, section 5.4.4. For default values,see section 7.2 -> TWAIT: > 5 min.

Definition at line 105 of file asymcute.h.

◆ CONFIG_ASYMCUTE_KEEPALIVE_PING

#define CONFIG_ASYMCUTE_KEEPALIVE_PING ((CONFIG_ASYMCUTE_KEEPALIVE / 4) * 3)

Interval to use for sending periodic ping messages.

The default behavior of this implementation is to send ping messages as soon as three quarters of the keep alive interval have passed.

Note: Must be less than CONFIG_ASYMCUTE_KEEPALIVE

Definition at line 117 of file asymcute.h.

◆ CONFIG_ASYMCUTE_N_RETRY

#define CONFIG_ASYMCUTE_N_RETRY (3U)

Number of retransmissions until requests time out.

Maximum number of retransmissions in the event that the retry timer times out. After 'CONFIG_ASYMCUTE_N_RETRY' number of retransmissions, the client aborts the procedure and assumes that its MQTT-SN connection to the gateway is disconnected. For more information, see MQTT-SN Spec v1.2, section 6.13. For default values, see section 7.2 -> Nretry: 3-5.

Definition at line 144 of file asymcute.h.

◆ CONFIG_ASYMCUTE_T_RETRY

#define CONFIG_ASYMCUTE_T_RETRY (10U)

Resend interval [in seconds].

Interval used for timing the retry messages which are sent when the expected reply from GW is not received. The retry timer is started by the client when the message is sent and stopped when the expected reply from GW is received. If the timer times out and the expected GW’s reply is not received, the client retransmits the message. For more information, see MQTT-SN Spec v1.2, section 6.13. For default values, see section 7.2 -> Tretry: 10 to 15 sec.

Definition at line 131 of file asymcute.h.

◆ CONFIG_ASYMCUTE_TOPIC_MAXLEN

#define CONFIG_ASYMCUTE_TOPIC_MAXLEN (32U)

Maximum topic length.

Note: Must be less than (256 - 8) AND less than ( CONFIG_ASYMCUTE_BUFSIZE - 8).

Definition at line 94 of file asymcute.h.