Diffusion C API
5.9.24
|
Types relating to topic messages and service messages. More...
Data Structures | |
struct | dpt_message_s |
Generic message; all DPT messages should fit into this structure. More... | |
struct | topic_message_s |
Structure for slightly simplified access to topic messages. More... | |
struct | v5_message_s |
Service messages over the V5 protocol are parsed into this common structure, with the unparsed service-specific content in the payload field. More... | |
struct | stream_message_options_s |
Additional options associated with a STREAM_MESSAGE_T. More... | |
struct | stream_message_s |
Messages directed to this session are received through a globally registered handler, and are parsed into this structure. More... | |
Macros | |
#define | DPT_MESSAGE_DELIM |
DPT protocol message delimiter. | |
#define | DPT_RECORD_DELIM |
DPT protocol record delimiter. | |
#define | DPT_FIELD_DELIM |
DPT protocol field delimiter. | |
#define | DPT_PROTOCOL_BYTE |
DPT protocol indicator in connection handshake. | |
#define | DPT_PROTOCOL_VERSION |
DPT protocol version indicator. | |
#define | DPT_CLIENT_TYPE |
DPT protocol client type = "C". | |
#define | WS_PROTOCOL_VERSION |
Diffusion protocol version to use with websocket connections. | |
#define | WS_CLIENT_TYPE |
WS protocol client type = "WC". | |
#define | DPT_CAPABILITIES |
Bitmask used to negotiate the client capabilities. More... | |
#define | DPT_ENCODING_NONE |
The connection is raw with no encoding. More... | |
#define | DPT_ENCODING_ENCRYPTION_REQUESTED |
The connection can handle encrypted data. More... | |
#define | DPT_ENCODING_COMPRESSION_REQUESTED |
The connection can handle compressed data. More... | |
#define | DPT_ENCODING_BASE64_REQUESTED |
The connection can handle base64 encoded data. More... | |
#define | DPT_ENCODING_ENCRYPTED |
The connection is encrypted. More... | |
#define | DPT_ENCODING_COMPRESSED |
The connection is compress. More... | |
#define | DPT_ENCODING_BASE64 |
The connection uses base64 encoding. More... | |
#define | DPT_RECONNECTION_REQUEST |
DPT recvonnection request indicator. | |
#define | MESSAGE_TYPE_MAX_VALUE |
The maximum allowed message type value. More... | |
Typedefs | |
typedef struct dpt_message_s | MESSAGE_T |
Generic message; all DPT messages should fit into this structure. | |
typedef struct topic_message_s | TOPIC_MESSAGE_T |
Structure for slightly simplified access to topic messages. More... | |
typedef struct v5_message_s | V5_MESSAGE_T |
Service messages over the V5 protocol are parsed into this common structure, with the unparsed service-specific content in the payload field. | |
typedef struct stream_message_options_s | STREAM_MESSAGE_OPTIONS_T |
Additional options associated with a STREAM_MESSAGE_T. | |
typedef struct stream_message_s | STREAM_MESSAGE_T |
Messages directed to this session are received through a globally registered handler, and are parsed into this structure. | |
Enumerations | |
enum | MESSAGE_TYPE_T { , MESSAGE_TYPE_TOPIC_LOAD, MESSAGE_TYPE_DELTA } |
An enumeration of messages types, corresponding to messages in the DPT v4 protocol. More... | |
Types relating to topic messages and service messages.
Copyright © 2014, 2015 Push Technology Ltd., All Rights Reserved.
Use is subject to license terms.
NOTICE: All information contained herein is, and remains the property of Push Technology. The intellectual and technical concepts contained herein are proprietary to Push Technology and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law.
#define DPT_CAPABILITIES |
Bitmask used to negotiate the client capabilities.
The C API only supports "Feature Clients" at this time.
#define DPT_ENCODING_BASE64 |
The connection uses base64 encoding.
#define DPT_ENCODING_BASE64_REQUESTED |
The connection can handle base64 encoded data.
#define DPT_ENCODING_COMPRESSED |
The connection is compress.
#define DPT_ENCODING_COMPRESSION_REQUESTED |
The connection can handle compressed data.
#define DPT_ENCODING_ENCRYPTED |
The connection is encrypted.
#define DPT_ENCODING_ENCRYPTION_REQUESTED |
The connection can handle encrypted data.
#define DPT_ENCODING_NONE |
The connection is raw with no encoding.
#define MESSAGE_TYPE_MAX_VALUE |
The maximum allowed message type value.
typedef struct topic_message_s TOPIC_MESSAGE_T |
Structure for slightly simplified access to topic messages.
Identical to MESSAGE_T except for the name field.
enum MESSAGE_TYPE_T |