Sebastián Pastor / EtheriosCloudConnector
Embed: (wiki syntax)

« Back to documentation index

Data Structures

Data Structures

Here are the data structures with brief descriptions:
connector_config_connect_type_tConnection action which is used to to tell the connector to make connection to Device Cloud automatically or manually
connector_config_connection_type_tDevice connection type configuration for connector_request_id_config_connection_type callback
connector_config_device_id_method_tDevice ID method configuration returned by the application's callback for connector_request_id_config_device_id_method callback
connector_config_error_status_tError status structure for connector_request_id_config_error_status callback which is called when Cloud Connector encounters an error
connector_config_identity_verification_tIdentify verification configuration for connector_request_id_config_identity_verification callback
connector_config_ip_address_tDevice IP Address Configuration for connector_request_id_config_ip_addr callback
connector_config_keepalive_tKeep-alive interval configuration used for the following callbacks:

  1. connector_request_id_config_tx_keepalive
  2. connector_request_id_config_rx_keepalive
connector_config_link_speed_tDevice link speed configuration for WAN connection type for connector_request_id_config_link_speed callback
connector_config_max_transaction_tDevice maximum transaction configuration for connector_request_id_config_max_transaction callback
connector_config_pointer_data_tApplication Binary Data Pointer Configuration for the following callbacks:

  1. connector_request_id_config_device_id
  2. connector_request_id_config_mac_addr
  3. connector_request_id_config_imei_number
  4. connector_request_id_config_esn
  5. connector_request_id_config_meid
connector_config_pointer_string_tApplication String Pointer Configuration for the following callbacks:
connector_config_supported_tService supported status configuration for the following callbacks:

  1. connector_request_id_config_firmware_facility
  2. connector_request_id_config_data_service
  3. connector_request_id_config_file_system
connector_config_vendor_id_tVendor ID configuration for connector_request_id_config_vendor_id callback
connector_config_wait_count_tDevice wait count configuration for connector_request_id_config_wait_count callback
connector_config_wan_type_tDevice WAN type configuration for connector_request_id_config_wan_type callback
connector_data_point_response_tThe data in the callback with request id connector_request_id_data_point_binary_response and connector_request_id_data_point_single_response will point to this data structure
connector_data_point_status_tThe data in the callback with request id connector_request_id_data_point_binary_status and connector_request_id_data_point_single_status will point to this data structure
connector_data_point_tData structure to make a linked list of data points to send it out in one transaction
connector_data_service_length_tThe callback data with request ID connector_request_id_data_service_send_length and connector_request_id_data_service_receive_reply_length will point to this structure
connector_data_service_receive_data_tThe callback data with request ID connector_request_id_data_service_receive_data will point to this structure
connector_data_service_receive_reply_data_tThe callback data with request ID connector_request_id_data_service_receive_reply_data will point to this structure
connector_data_service_receive_target_tThe callback data with request ID connector_request_id_data_service_receive_target will point to this structure
connector_data_service_send_data_tThe callback data with request ID connector_request_id_data_service_send_data will point to this structure
connector_data_service_send_response_tThe callback data with request ID connector_request_id_data_service_send_response will point to this structure
connector_data_service_status_tThe callback data with request ID connector_request_id_data_service_send_status and connector_request_id_data_service_receive_status will point to this structure
connector_file_system_close_tData structure used in connector_request_id_file_system_close callback
connector_file_system_get_error_tData structure used in connector_request_id_file_system_get_error callback, to get error status and description for a previously recorder error token
connector_file_system_hash_tData structure used in connector_request_id_file_system_hash callback
connector_file_system_lseek_tData structure used in connector_request_id_file_system_lseek callback
connector_file_system_open_tData structure used in connector_request_id_file_system_open callback
connector_file_system_opendir_tData structure used in connector_request_id_file_system_opendir callback
connector_file_system_read_tData structure used in connector_request_id_file_system_read callback
connector_file_system_readdir_tData structure used in connector_request_id_file_system_readdir callback
connector_file_system_remove_tData structure used in connector_request_id_file_system_remove callback
connector_file_system_session_error_tData structure used in connector_request_id_file_system_session_error callback
connector_file_system_stat_dir_entry_tData structure used in connector_request_id_file_system_stat_dir_entry callback, used to get status for for each directory entry in the directory path, received from Device Cloud for ls request
connector_file_system_stat_tData structure used in connector_request_id_file_system_stat callback, used to get status for a path received from Device Cloud for ls request
connector_file_system_statbuf_tFile status data structure is used to return the status of a directory or a file, specified by the path
connector_file_system_truncate_tData structure used in connector_request_id_file_system_ftruncate callback
connector_file_system_write_tData structure used in connector_request_id_file_system_write callback
connector_firmware_count_tFirmware target count for connector_request_id_firmware_count callback which is called to return number of supported targets
connector_firmware_download_abort_tFirmware download abort structure for connector_request_id_firmware_abort callback which is called when firmware download process is aborted
connector_firmware_download_complete_tFirmware download complete structure containing information about firmware image data for connector_request_id_firmware_download_complete callback which is called when Device Cloud is done sending all image data
connector_firmware_download_data_tFirmware download image data structure for connector_request_id_firmware_download_data callback which is called when the connector receives a block of image data for firmware download
connector_firmware_download_start_tFirmware download start structure for connector_request_id_firmware_download_start callback which is called when the device is requested for firmware download
connector_firmware_info_tFirmware information structure for connector_request_id_firmware_info callback to return information about the specific target
connector_firmware_reset_tFirmware target reset structure for connector_request_id_firmware_reset callback which is called to reset the target
connector_firmware_version_tFirmware version structure for connector_request_id_firmware_info callback to return the firmware version about the specific target
connector_initiate_stop_request_tThis data structure is used on connector_initiate_transport_stop in Initiate Action API to stop a transport
connector_network_close_tClose request structure for connector_request_id_network_close callback which is called to close the connection to Device Cloud
connector_network_open_tNetwork open data structure for connector_request_id_network_open callback which is called to open and connect to Device Cloud
connector_network_receive_tRead request structure for connector_request_id_network_receive callback which is called to receive a specified number of bytes data from Device Cloud
connector_network_send_tSend data structure for connector_request_id_network_send callback which is called to send data to Device Cloud
connector_os_free_tStructure passed to connector_request_id_os_free callback
connector_os_malloc_tStructure passed to connector_request_id_os_malloc callback
connector_os_system_up_time_tStructure passed to connector_request_id_os_system_up_time callback
connector_os_yield_tStructure passed to connector_request_id_os_yield callback
connector_request_data_point_binary_tThis data structure is used when the connector_initiate_action() API is called with connector_initiate_binary_point request id
connector_request_data_point_single_tThis data structure is used when the connector_initiate_action() API is called with connector_initiate_data_point_single request id
connector_request_data_service_send_tThis structure is used when sending a data to Device Cloud with connector_initiate_action() call.The action ID used for this call is connector_initiate_send_data
connector_request_id_tRequest IDs passed to callback identifying the type of request
connector_sm_cancel_request_tThis data structure is used when the device initiates the cancel session request
connector_sm_cli_request_tThis data structure is used when the callback is called to pass the CLI request received from Device Cloud
connector_sm_cli_response_length_tThis data structure is used when the callback is called to get the CLI response length
connector_sm_cli_response_tThis data structure is used when the callback is called to get the CLI response to Device Cloud
connector_sm_cli_status_tThis data structure is used when the callback is called to indicate the termination of CLI session
connector_sm_more_data_tThis data structure is used when the callback is called with the connector_request_id_more_data
connector_sm_opaque_response_tThis data structure is used when the callback is called to pass Device Cloud response for which the associated request is not present
connector_sm_ping_response_tThis data structure is used when the callback is called with the connector_request_id_sm_ping_response
connector_sm_receive_config_request_tThis data structure is used when the the callback is called with the connector_request_id_sm_config_request
connector_sm_receive_ping_request_tThis data structure is used when the the callback is called with the connector_request_id_sm_ping_request
connector_sm_send_ping_request_tThis data structure is used when the device initiates the ping request to Device Cloud
connector_status_tcp_event_tTCP status structure is used for connector_request_id_status_tcp callback
connector_time_epoch_fractional_tThe data structure to represent seconds and milliseconds since the epoch (00:00:00 UTC on 1 January 1970)
connector_time_epoch_whole_tThe data structure to represent milliseconds since the epoch (00:00:00 UTC on 1 January 1970)