Initiate Action

Requests Cloud Connector to perform an asynchronous action.

This function is called to initiate an Cloud Connector action. It can be used to initiate a send data sequence from the device to Device Cloud, or to terminate Cloud Connector library.

Parameters:

[in]	handle	Handle returned from the connector_init() call.
[in]	request	Request action (one of the following): connector_initiate_terminate: Terminates and stops Cloud Connector from running. This call closes all open network Handles and frees all allocated memory. If the application is using connector_step(), the next call to connector_step() terminates Cloud Connector. If a blocking call to connector_run() is still pending, this call will eventually terminate that call. Once Cloud Connector is terminated, the Cloud Connector must restart by calling connector_init(). connector_initiate_send_data: This is used to trigger the send data to Device Cloud. Only the header information is passed by this method. The actual data is transferred through callbacks. The data is stored in a specified file on Device Cloud. connector_initiate_transport_start: Starts the specified (connector_transport_tcp , connector_transport_udp or connector_transport_sms) transport method. connector_initiate_transport_stop: Stops the Cloud Connector transport mechanism. Note this call triggers a connector_request_id_status_stop_completed callback. Transports include: connector_transport_tcp - TCP transport connector_transport_udp - UDP transport connector_transport_sms - SMS transport connector_transport_all - all transports. connector_initiate_data_point_binary: Initiates the action to send a binary data point to Device Cloud. connector_initiate_data_point_single: Initiates the action to send data points which are belongs to a single stream on Device Cloud. connector_initiate_ping_request: Sends status message to the Device Cloud. Supported for connector_transport_udp and connector_transport_sms transports method only. connector_initiate_session_cancel: Initiates the action to cancel a session.
[in]	request_data	Pointer to Request data connector_initiate_terminate: Should be NULL. connector_initiate_send_data: Pointer to connector_request_data_service_send_t. connector_initiate_transport_start: Pointer to connector_transport_t connector_initiate_transport_stop: Pointer to connector_initiate_stop_request_t connector_initiate_data_point_binary: Pointer to connector_request_data_point_binary_t connector_initiate_data_point_single: Pointer to connector_request_data_point_single_t connector_initiate_ping_request: Pointer to connector_sm_send_ping_request_t connector_initiate_session_cancel: Pointer to connector_sm_cancel_request_t

Return values:

connector_success	No error
connector_init_error	Cloud Connector was not initialized or not connected to Device Cloud.
connector_abort	Callback aborted Cloud Connector.
connector_invalid_data	Invalid parameter
connector_no_resource	Insufficient memory
connector_service_busy	Cloud Connector is busy

Example Usage:

     static connector_request_data_service_send_t  file_info;
     :
     status = connector_initiate_action(handle, connector_initiate_send_data, &file_info);
     :
     :
     status = connector_initiate_action(connector_handle, connector_initiate_terminate, NULL);

See also:

Cloud Connector Handle

connector_callback_t

Definition at line 577 of file connector_api.c.