Classes
struct	CC_MqttsnWillInfo
	Information on the "will" operation completion. More...

Typedefs
typedef void(*	CC_MqttsnWillCompleteCb) (void data, CC_MqttsnAsyncOpStatus status, const CC_MqttsnWillInfo info)
	Callback used to report completion of the publish operation.

typedef struct CC_MqttsnWill *	CC_MqttsnWillHandle
	Handle for "will" operation.

Functions
CC_MqttsnErrorCode	cc_mqttsn_client_will (CC_MqttsnClientHandle client, const CC_MqttsnWillConfig config, CC_MqttsnWillCompleteCb cb, void cbData)
	Prepare and send "will" request in one go.

CC_MqttsnErrorCode	cc_mqttsn_client_will_cancel (CC_MqttsnWillHandle handle)
	Cancel the allocated "will" operation.

CC_MqttsnErrorCode	cc_mqttsn_client_will_config (CC_MqttsnWillHandle handle, const CC_MqttsnWillConfig *config)
	Perform configuration of the "will" operation.

unsigned	cc_mqttsn_client_will_get_retry_count (CC_MqttsnWillHandle handle)
	Retrieve the configured retry count for the "will" operation.

unsigned	cc_mqttsn_client_will_get_retry_period (CC_MqttsnWillHandle handle)
	Retrieve the configured retry period for the "will" operation.

void	cc_mqttsn_client_will_init_config (CC_MqttsnWillConfig *config)
	Intialize the CC_MqttsnWillConfig configuration structure.

CC_MqttsnWillHandle	cc_mqttsn_client_will_prepare (CC_MqttsnClientHandle client, CC_MqttsnErrorCode *ec)
	Prepare "will" operation.

CC_MqttsnErrorCode	cc_mqttsn_client_will_send (CC_MqttsnWillHandle handle, CC_MqttsnWillCompleteCb cb, void *cbData)
	Send the "will" operation.

CC_MqttsnErrorCode	cc_mqttsn_client_will_set_retry_count (CC_MqttsnWillHandle handle, unsigned count)
	Configure the retry count for the "will" operation.

CC_MqttsnErrorCode	cc_mqttsn_client_will_set_retry_period (CC_MqttsnWillHandle handle, unsigned ms)
	Configure the retry period for the "will" operation.

Detailed Description

Typedef Documentation

◆ CC_MqttsnWillCompleteCb

typedef void(* CC_MqttsnWillCompleteCb) (void *data, CC_MqttsnAsyncOpStatus status, const CC_MqttsnWillInfo *info)

Callback used to report completion of the publish operation.

Parameters

[in]	data	Pointer to user data object, passed as the last parameter to the request call.
[in]	status	Status of the "will" operation.
[in]	info	Information about op completion. Not-NULL is reported if and onfly if the "status" is equal to CC_MqttsnAsyncOpStatus_Complete.

Postcondition: The data members of the reported response can NOT be accessed after the function returns.

◆ CC_MqttsnWillHandle

typedef struct CC_MqttsnWill* CC_MqttsnWillHandle

Handle for "will" operation.

Returned by cc_mqttsn_client_will_prepare() function.

Function Documentation

◆ cc_mqttsn_client_will()

CC_MqttsnErrorCode cc_mqttsn_client_will	(	CC_MqttsnClientHandle	client,
		const CC_MqttsnWillConfig *	config,
		CC_MqttsnWillCompleteCb	cb,
		void *	cbData
	)

Prepare and send "will" request in one go.

Abstracts away sequence of the following functions invocation:

Parameters

[in]	client	Handle returned by cc_mqttsn_client_alloc() function.
[in]	config	Subscription configuration.
[in]	cb	Callback to be invoked when "will" operation is complete.
[in]	cbData	Pointer to any user data structure. It will passed as one of the parameters in callback invocation. May be NULL.

Returns: Result code of the call.

◆ cc_mqttsn_client_will_cancel()

CC_MqttsnErrorCode cc_mqttsn_client_will_cancel ( CC_MqttsnWillHandle handle )

Cancel the allocated "will" operation.

In case the cc_mqttsn_client_will_send() function was successfully called before, the operation is cancelled without callback invocation.

Parameters

[in] handle Handle returned by cc_mqttsn_client_will_prepare() function.

Returns: Result code of the call.

Postcondition: The handle of the "will" operation is no longer valid and must be discarded.

◆ cc_mqttsn_client_will_config()

CC_MqttsnErrorCode cc_mqttsn_client_will_config	(	CC_MqttsnWillHandle	handle,
		const CC_MqttsnWillConfig *	config
	)

Perform configuration of the "will" operation.

Parameters

[in]	handle	Handle returned by cc_mqttsn_client_will_prepare() function.
[in]	config	Configuration structure. Must NOT be NULL. Does not need to be preserved after invocation.

Returns: Result code of the call.

◆ cc_mqttsn_client_will_get_retry_count()

unsigned cc_mqttsn_client_will_get_retry_count ( CC_MqttsnWillHandle handle )

Retrieve the configured retry count for the "will" operation.

Parameters

[in] handle Handle returned by cc_mqttsn_client_will_prepare() function.

Returns: Number of retries.

◆ cc_mqttsn_client_will_get_retry_period()

unsigned cc_mqttsn_client_will_get_retry_period ( CC_MqttsnWillHandle handle )

Retrieve the configured retry period for the "will" operation.

Parameters

[in] handle Handle returned by cc_mqttsn_client_will_prepare() function.

Returns: Retry period duration in milliseconds.

◆ cc_mqttsn_client_will_init_config()

void cc_mqttsn_client_will_init_config ( CC_MqttsnWillConfig * config )

Intialize the CC_MqttsnWillConfig configuration structure.

Parameters

[out] config Configuration structure. Must not be NULL.

◆ cc_mqttsn_client_will_prepare()

CC_MqttsnWillHandle cc_mqttsn_client_will_prepare	(	CC_MqttsnClientHandle	client,
		CC_MqttsnErrorCode *	ec
	)

Prepare "will" operation.

Parameters

[in]	client	Handle returned by cc_mqttsn_client_alloc() function.
[out]	ec	Error code reporting result of the operation. Can be NULL.

Returns: Handle of the "will" operation, will be NULL in case of failure. To analyze the reason failure use "ec" output parameter.

Postcondition: The "will" operation is allocated, use either cc_mqttsn_client_will_send() or cc_mqttsn_client_will_cancel() to prevent memory leaks.

◆ cc_mqttsn_client_will_send()

CC_MqttsnErrorCode cc_mqttsn_client_will_send	(	CC_MqttsnWillHandle	handle,
		CC_MqttsnWillCompleteCb	cb,
		void *	cbData
	)

Send the "will" operation.

Parameters

[in]	handle	Handle returned by cc_mqttsn_client_will_prepare() function.
[in]	cb	Callback to be invoked when "will" operation is complete.
[in]	cbData	Pointer to any user data structure. It will passed as one of the parameters in callback invocation. May be NULL.

Returns: Result code of the call.

Postcondition: The handle of the "will" operation can be discarded.; The provided callback will be invoked when the "will" operation is complete if and only if the function returns CC_MqttsnErrorCode_Success.

◆ cc_mqttsn_client_will_set_retry_count()

CC_MqttsnErrorCode cc_mqttsn_client_will_set_retry_count	(	CC_MqttsnWillHandle	handle,
		unsigned	count
	)

Configure the retry count for the "will" operation.

Parameters

[in]	handle	Handle returned by cc_mqttsn_client_will_prepare() function.
[in]	count	Number of retries.

Returns: Result code of the call.

◆ cc_mqttsn_client_will_set_retry_period()

CC_MqttsnErrorCode cc_mqttsn_client_will_set_retry_period	(	CC_MqttsnWillHandle	handle,
		unsigned	ms
	)

Configure the retry period for the "will" operation.

Parameters

[in]	handle	Handle returned by cc_mqttsn_client_will_prepare() function.
[in]	ms	Retry period in milliseconds.

Returns: Result code of the call.

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ CC_MqttsnWillCompleteCb

◆ CC_MqttsnWillHandle

Function Documentation

◆ cc_mqttsn_client_will()

◆ cc_mqttsn_client_will_cancel()

◆ cc_mqttsn_client_will_config()

◆ cc_mqttsn_client_will_get_retry_count()

◆ cc_mqttsn_client_will_get_retry_period()

◆ cc_mqttsn_client_will_init_config()

◆ cc_mqttsn_client_will_prepare()

◆ cc_mqttsn_client_will_send()

◆ cc_mqttsn_client_will_set_retry_count()

◆ cc_mqttsn_client_will_set_retry_period()