Hazelnet Client constant configuration. More...

#include <hzl_Client.h>

Data Fields
HZL_SET_BY_USER uint16_t	timeoutReqToResMillis
	Duration in milliseconds until a Request times out (t_{reqres}). More...

HZL_SET_BY_USER uint8_t	ltk [HZL_LTK_LEN]
	Symmetric Long Term Key of this Client (LTK_{AS}), uniquely identifying this Client against the Server. More...

HZL_SET_BY_USER hzl_Sid_t	sid
	Source Identifier of this Client. More...

HZL_SET_BY_USER uint8_t	headerType
	Header Type (h) used by the network of CBS-enabled nodes. More...

HZL_SET_BY_USER uint8_t	amountOfGroups
	Only Groups this client is in, i.e. More...

uint8_t	unusedPadding [1]
	Padding to the next struct. More...

Detailed Description

Hazelnet Client constant configuration.

Single instance per Client. Initialised by the user, not modified by the Client. Initialised by the user, not modified by the Client.

Field Documentation

◆ timeoutReqToResMillis

HZL_SET_BY_USER uint16_t hzl_ClientConfig::timeoutReqToResMillis

Duration in milliseconds until a Request times out (t_{reqres}).

Measured between the TX function call (may be asynchronous) of the Request and the processing of the Response, so overhead latencies may be included. May have any value in [0, 0xFFFF].

◆ ltk

HZL_SET_BY_USER uint8_t hzl_ClientConfig::ltk[HZL_LTK_LEN]

Symmetric Long Term Key of this Client (LTK_{AS}), uniquely identifying this Client against the Server.

Only the Server has another copy. Must not be all-zeros.

◆ sid

HZL_SET_BY_USER hzl_Sid_t hzl_ClientConfig::sid

Source Identifier of this Client.

Unique across all Clients. Must not be HZL_SERVER_SID.

◆ headerType

HZL_SET_BY_USER uint8_t hzl_ClientConfig::headerType

Header Type (h) used by the network of CBS-enabled nodes.

Must be the same as all other nodes, otherwise the messages will not be interpreted correctly, both sent and received. Must be one of hzl_HeaderType_t enum fields.

◆ amountOfGroups

HZL_SET_BY_USER uint8_t hzl_ClientConfig::amountOfGroups

Only Groups this client is in, i.e.

amount of hzl_ClientGroupConfig_t instances.

Must be >= 1.

◆ unusedPadding

uint8_t hzl_ClientConfig::unusedPadding[1]

Padding to the next struct.

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

inc/hzl_Client.h

Data Fields