"Unsubscribe Operation Data Types and Functions"

Classes
struct	CC_MqttsnUnsubscribeConfig
	Configuration the "unsubscribe" operation. More...

Typedefs
typedef void(*	CC_MqttsnUnsubscribeCompleteCb) (void *data, CC_MqttsnUnsubscribeHandle handle, CC_MqttsnAsyncOpStatus status)
	Callback used to report completion of the unsubscribe operation.

Functions
CC_MqttsnErrorCode	cc_mqttsn_client_unsubscribe (CC_MqttsnClientHandle client, const CC_MqttsnUnsubscribeConfig *config, CC_MqttsnUnsubscribeCompleteCb cb, void *cbData)
	Prepare and send "unsubscribe" request in one go.
CC_MqttsnErrorCode	cc_mqttsn_client_unsubscribe_cancel (CC_MqttsnUnsubscribeHandle handle)
	Cancel the allocated "unsubscribe" operation.
CC_MqttsnErrorCode	cc_mqttsn_client_unsubscribe_config (CC_MqttsnUnsubscribeHandle handle, const CC_MqttsnUnsubscribeConfig *config)
	Perform configuration of the "unsubscribe" operation.
unsigned	cc_mqttsn_client_unsubscribe_get_retry_count (CC_MqttsnUnsubscribeHandle handle)
	Retrieve the configured retry count for the "unsubscribe" operation.
unsigned	cc_mqttsn_client_unsubscribe_get_retry_period (CC_MqttsnUnsubscribeHandle handle)
	Retrieve the configured retry period for the "unsubscribe" operation.
void	cc_mqttsn_client_unsubscribe_init_config (CC_MqttsnUnsubscribeConfig *config)
	Intialize the CC_MqttsnUnsubscribeConfig configuration structure.
CC_MqttsnUnsubscribeHandle	cc_mqttsn_client_unsubscribe_prepare (CC_MqttsnClientHandle client, CC_MqttsnErrorCode *ec)
	Prepare "unsubscribe" operation.
CC_MqttsnErrorCode	cc_mqttsn_client_unsubscribe_send (CC_MqttsnUnsubscribeHandle handle, CC_MqttsnUnsubscribeCompleteCb cb, void *cbData)
	Send the "unsubscribe" operation.
CC_MqttsnErrorCode	cc_mqttsn_client_unsubscribe_set_retry_count (CC_MqttsnUnsubscribeHandle handle, unsigned count)
	Configure the retry count for the "unsubscribe" operation.
CC_MqttsnErrorCode	cc_mqttsn_client_unsubscribe_set_retry_period (CC_MqttsnUnsubscribeHandle handle, unsigned ms)
	Configure the retry period for the "unsubscribe" operation.

Detailed Description

Typedef Documentation

CC_MqttsnUnsubscribeCompleteCb

typedef void(* CC_MqttsnUnsubscribeCompleteCb) (void *data, CC_MqttsnUnsubscribeHandle handle, CC_MqttsnAsyncOpStatus status)

Callback used to report completion of the unsubscribe operation.

Parameters

[in]	data	Pointer to user data object, passed as the last parameter to the request call.
[in]	handle	Handle returned by cc_mqttsn_client_unsubscribe_prepare() function. When the callback is invoked the handle is already invalid and cannot be used in any relevant function invocation, but it allows end application to identify the original "unsubscribe" operation and use the same callback function in parallel requests.
[in]	status	Status of the "unsubscribe" operation.

Postcondition

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

Function Documentation

cc_mqttsn_client_unsubscribe()

CC_MqttsnErrorCode cc_mqttsn_client_unsubscribe	(	CC_MqttsnClientHandle	client,
		const CC_MqttsnUnsubscribeConfig *	config,
		CC_MqttsnUnsubscribeCompleteCb	cb,
		void *	cbData
	)

Prepare and send "unsubscribe" request in one go.

Abstracts away sequence of the following functions invocation:

• cc_mqttsn_client_unsubscribe_prepare()
• cc_mqttsn_client_unsubscribe_config()
• cc_mqttsn_client_unsubscribe_send()

Parameters

[in]	client	Handle returned by cc_mqttsn_client_alloc() function.
[in]	config	Subscription configuration.
[in]	cb	Callback to be invoked when "unsubscribe" 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_unsubscribe_cancel()

CC_MqttsnErrorCode cc_mqttsn_client_unsubscribe_cancel

(

CC_MqttsnUnsubscribeHandle

handle

)

Cancel the allocated "unsubscribe" operation.

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

Parameters

[in]

handle

Handle returned by cc_mqttsn_client_unsubscribe_prepare() function.

Returns

Result code of the call.

Postcondition

The handle of the "unsubscribe" operation is no longer valid and must be discarded.

cc_mqttsn_client_unsubscribe_config()

CC_MqttsnErrorCode cc_mqttsn_client_unsubscribe_config	(	CC_MqttsnUnsubscribeHandle	handle,
		const CC_MqttsnUnsubscribeConfig *	config
	)

Perform configuration of the "unsubscribe" operation.

Parameters

[in]	handle	Handle returned by cc_mqttsn_client_unsubscribe_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_unsubscribe_get_retry_count()

unsigned cc_mqttsn_client_unsubscribe_get_retry_count

(

CC_MqttsnUnsubscribeHandle

handle

)

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

Parameters

[in]

handle

Handle returned by cc_mqttsn_client_unsubscribe_prepare() function.

Returns

Number of retries.

cc_mqttsn_client_unsubscribe_get_retry_period()

unsigned cc_mqttsn_client_unsubscribe_get_retry_period

(

CC_MqttsnUnsubscribeHandle

handle

)

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

Parameters

[in]

handle

Handle returned by cc_mqttsn_client_unsubscribe_prepare() function.

Returns

Retry period duration in milliseconds.

cc_mqttsn_client_unsubscribe_init_config()

void cc_mqttsn_client_unsubscribe_init_config

(

CC_MqttsnUnsubscribeConfig *

config

)

Intialize the CC_MqttsnUnsubscribeConfig configuration structure.

Parameters

[out]

config

Configuration structure. Must not be NULL.

cc_mqttsn_client_unsubscribe_prepare()

CC_MqttsnUnsubscribeHandle cc_mqttsn_client_unsubscribe_prepare	(	CC_MqttsnClientHandle	client,
		CC_MqttsnErrorCode *	ec
	)

Prepare "unsubscribe" 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 "unsubscribe" operation, will be NULL in case of failure. To analyze the reason failure use "ec" output parameter.

Postcondition

The "unsubscribe" operation is allocated, use either cc_mqttsn_client_unsubscribe_send() or cc_mqttsn_client_unsubscribe_cancel() to prevent memory leaks.

cc_mqttsn_client_unsubscribe_send()

CC_MqttsnErrorCode cc_mqttsn_client_unsubscribe_send	(	CC_MqttsnUnsubscribeHandle	handle,
		CC_MqttsnUnsubscribeCompleteCb	cb,
		void *	cbData
	)

Send the "unsubscribe" operation.

Parameters

[in]	handle	Handle returned by cc_mqttsn_client_unsubscribe_prepare() function.
[in]	cb	Callback to be invoked when "unsubscribe" 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 "unsubscribe" operation can be discarded.

The provided callback will be invoked when the "unsubscribe" operation is complete if and only if the function returns CC_MqttsnErrorCode_Success.

cc_mqttsn_client_unsubscribe_set_retry_count()

CC_MqttsnErrorCode cc_mqttsn_client_unsubscribe_set_retry_count	(	CC_MqttsnUnsubscribeHandle	handle,
		unsigned	count
	)

Configure the retry count for the "unsubscribe" operation.

Parameters

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

Returns

Result code of the call.

cc_mqttsn_client_unsubscribe_set_retry_period()

CC_MqttsnErrorCode cc_mqttsn_client_unsubscribe_set_retry_period	(	CC_MqttsnUnsubscribeHandle	handle,
		unsigned	ms
	)

Configure the retry period for the "unsubscribe" operation.

Parameters

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

Returns

Result code of the call.