C Messaging API Reference for Oracle Internet of Things Cloud Service Client Software Library. Release 21.1.1.0.0-3. E70344-26
iotcs_message.h File Reference

The file defines the public API for building IoT Messages. More...

#include "iotcs.h"

Go to the source code of this file.

Structures

struct  iotcs_data_item_desc
 IoT CS data item description structure. More...
struct  iotcs_data_item
 IoT CS data item structure. More...
struct  iotcs_message_diagnostic
 IoT CS message diagnostic item. More...
struct  iotcs_message_property
 IoT CS message property. More...
struct  iotcs_message_base
 IoT CS message base structure. More...
struct  iotcs_data_message_base
 IoT CS data message base structure. More...
struct  iotcs_data_message
 IoT CS data message structure. More...
struct  iotcs_alert_message_base
 IoT CS alert message base structure. More...
struct  iotcs_alert_message
 IoT CS alert message structure. More...
struct  iotcs_resource_message_base
 Resource description structure. More...
struct  iotcs_resource_message
 IoT CS resource message structure. More...
struct  iotcs_request_message
 IoT CS request message structure. More...
struct  iotcs_response_message
 IoT CS response message structure. More...
struct  iotcs_message
 IoT CS message structure. More...

Enumerations

enum  iotcs_message_type {
  IOTCS_MESSAGE_DATA = 0, IOTCS_MESSAGE_ALERT = 1, IOTCS_MESSAGE_REQUEST = 2, IOTCS_MESSAGE_RESPONSE = 3,
  IOTCS_MESSAGE_RESOURCE = 4
}
 IoT CS Message type.
enum  iotcs_message_priority {
  IOTCS_MESSAGE_PRIORITY_LOWEST = 0, IOTCS_MESSAGE_PRIORITY_LOW = 1, IOTCS_MESSAGE_PRIORITY_MEDIUM = 2, IOTCS_MESSAGE_PRIORITY_HIGH = 3,
  IOTCS_MESSAGE_PRIORITY_HIGHEST = 4, IOTCS_MESSAGE_PRIORITY_DEFAULT = IOTCS_MESSAGE_PRIORITY_LOW
}
 IoT CS Message priority values.
enum  iotcs_message_reliability { IOTCS_MESSAGE_RELIABILITY_NO_GUARANTEE = 0, IOTCS_MESSAGE_RELIABILITY_BEST_EFFORT = 1, IOTCS_MESSAGE_RELIABILITY_GUARANTED_DELIVERY = 2, IOTCS_MESSAGE_RELIABILITY_DEFAULT = IOTCS_MESSAGE_RELIABILITY_BEST_EFFORT }
 IoT CS Message reliability values. More...
enum  iotcs_message_severity {
  IOTCS_MESSAGE_SEVERITY_CRITICAL = 0, IOTCS_MESSAGE_SEVERITY_SIGNIFICANT = 1, IOTCS_MESSAGE_SEVERITY_NORMAL = 2, IOTCS_MESSAGE_SEVERITY_LOW = 3,
  IOTCS_MESSAGE_SEVERITY_DEFAULT = IOTCS_MESSAGE_SEVERITY_SIGNIFICANT
}
 Alert Message severity level.
enum  iotcs_resource_message_type { IOTCS_RESOURCE_MESSAGE_UPDATE = 0, IOTCS_RESOURCE_MESSAGE_DELETE = 1, IOTCS_RESOURCE_MESSAGE_RECONCILIATION = 2 }
 IoT CS Resource Message type.
enum  iotcs_request_method { IOTCS_REQUEST_METHOD_DELETE = 1, IOTCS_REQUEST_METHOD_GET = 2, IOTCS_REQUEST_METHOD_POST = 8, IOTCS_REQUEST_METHOD_PUT = 16 }
 Contains values of the request methods. More...

Detailed Description

The file defines the public API for building IoT Messages.


Enumeration Type Documentation

IoT CS Message reliability values.

Enumerator:
IOTCS_MESSAGE_RELIABILITY_BEST_EFFORT 

Default relability.

Contains values of the request methods.

Enumerator:
IOTCS_REQUEST_METHOD_DELETE 

DELETE method.

IOTCS_REQUEST_METHOD_GET 

GET method.

IOTCS_REQUEST_METHOD_POST 

POST method.

IOTCS_REQUEST_METHOD_PUT 

PUT method.