"Disconnect Operation Data Type and Functions"

Typedefs
typedef struct CC_Mqtt311Disconnect *	CC_Mqtt311DisconnectHandle
	Handle for "disconnect" operation.

Functions
CC_Mqtt311ErrorCode	cc_mqtt311_client_disconnect (CC_Mqtt311ClientHandle handle)
	Prepare, and send "disconnect" request in one go.
CC_Mqtt311ErrorCode	cc_mqtt311_client_disconnect_cancel (CC_Mqtt311DisconnectHandle handle)
	Cancel the allocated "disconnect" operation.
CC_Mqtt311DisconnectHandle	cc_mqtt311_client_disconnect_prepare (CC_Mqtt311ClientHandle handle, CC_Mqtt311ErrorCode *ec)
	Prepare "disconnect" operation.
CC_Mqtt311ErrorCode	cc_mqtt311_client_disconnect_send (CC_Mqtt311DisconnectHandle handle)
	Send the configured "disconnect" operation to broker.

Detailed Description

Typedef Documentation

CC_Mqtt311DisconnectHandle

typedef struct CC_Mqtt311Disconnect* CC_Mqtt311DisconnectHandle

Handle for "disconnect" operation.

Returned by cc_mqtt311_client_disconnect_prepare() function.

Function Documentation

cc_mqtt311_client_disconnect()

CC_Mqtt311ErrorCode cc_mqtt311_client_disconnect

(

CC_Mqtt311ClientHandle

handle

)

Prepare, and send "disconnect" request in one go.

Abstracts away sequence of the following functions invocation:

• cc_mqtt311_client_disconnect_prepare()
• cc_mqtt311_client_disconnect_send()

Parameters

[in]

handle

Handle returned by cc_mqtt311_client_alloc() function.

Returns

Result code of the call.

cc_mqtt311_client_disconnect_cancel()

CC_Mqtt311ErrorCode cc_mqtt311_client_disconnect_cancel

(

CC_Mqtt311DisconnectHandle

handle

)

Cancel the allocated "disconnect" operation.

Parameters

[in]

handle

Handle returned by cc_mqtt311_client_disconnect_prepare() function.

Returns

Result code of the call.

Postcondition

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

cc_mqtt311_client_disconnect_prepare()

CC_Mqtt311DisconnectHandle cc_mqtt311_client_disconnect_prepare	(	CC_Mqtt311ClientHandle	handle,
		CC_Mqtt311ErrorCode *	ec
	)

Prepare "disconnect" operation.

For successful operation the client needs to be in the "connected" state and there were no other prepared or complete "disconnect" operation since last "connect" operation.

Parameters

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

Returns

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

Postcondition

The "disconnect" operation is allocated, use either cc_mqtt311_client_disconnect_send() or cc_mqtt311_client_disconnect_cancel() to prevent memory leaks.

cc_mqtt311_client_disconnect_send()

CC_Mqtt311ErrorCode cc_mqtt311_client_disconnect_send

(

CC_Mqtt311DisconnectHandle

handle

)

Send the configured "disconnect" operation to broker.

Parameters

[in]

handle

Handle returned by cc_mqtt311_client_disconnect_prepare() function.

Returns

Result code of the call.

Postcondition

The handle of the "disconnect" operation is not longer valid and must be discarded.