Types relating to topic messages and service messages. More...

Data Structures
struct	message_s
	Generic message; all 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	RECORD_DELIM
	protocol record delimiter

#define	FIELD_DELIM
	protocol field delimiter

#define	PROTOCOL_BYTE
	protocol indicator in connection handshake

#define	WS_PROTOCOL_VERSION
	Diffusion protocol version to use with websocket connections.

#define	WS_CLIENT_TYPE
	WS protocol client type = "WC".

#define	CAPABILITIES
	Bitmask used to negotiate the client capabilities.

#define	ENCODING_NONE
	The connection is raw with no encoding.

#define	ENCODING_COMPRESSED
	The connection is compressed.

#define	MESSAGE_TYPE_MAX_VALUE
	The maximum allowed message type value.

Typedefs
typedef struct message_s	MESSAGE_T
	Generic message; all messages should fit into this structure.

typedef struct topic_message_s	TOPIC_MESSAGE_T
	Structure for slightly simplified access to topic messages.

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 { }
	An enumeration of messages types, corresponding to messages in the v4 protocol. More...

Detailed Description

Types relating to topic messages and service messages.

Use is subject to licence terms.

NOTICE: All information contained herein is, and remains the property of DiffusionData. The intellectual and technical concepts contained herein are proprietary to DiffusionData and may be covered by U.S. and Foreign Patents, patents in process, and are protected by trade secret or copyright law.

Macro Definition Documentation

◆ CAPABILITIES

#define CAPABILITIES

Bitmask used to negotiate the client capabilities.

The C API only supports "Feature Clients" at this time.

0000 0000 None
0000 0001 Encrypt
0000 0010 Compress
0000 0100 Base64
0000 1000 Feature

Typedef Documentation

◆ TOPIC_MESSAGE_T

typedef struct topic_message_s TOPIC_MESSAGE_T

Structure for slightly simplified access to topic messages.

Identical to MESSAGE_T except for the name and specification fields.

Enumeration Type Documentation

◆ MESSAGE_TYPE_T

enum MESSAGE_TYPE_T

An enumeration of messages types, corresponding to messages in the v4 protocol.

Enumerator
MESSAGE_TYPE_SERVICE_REQUEST	Message type constant. Direction: both Introduced: protocol 9. Since 5.9
MESSAGE_TYPE_TOPIC_VALUE	Message type constant. Direction: server->client Introduced: protocol 10. Since 5.9
MESSAGE_TYPE_TOPIC_DELTA	Message type constant. Direction: server->client Introduced: protocol 10. Since 5.9
MESSAGE_TYPE_SERVICE_RESPONSE	Message type constant. Direction: both Introduced: protocol 18. Since 6.5
MESSAGE_TYPE_SERVICE_ERROR	Message type constant. Direction: both Introduced: protocol 18. Since 6.5
MESSAGE_TYPE_ABORT	Message type constant. Direction: server->client Unused in protocol 5-9. Reintroduced in protocol 10.
MESSAGE_TYPE_CLOSE_REQUEST	Message type constant. Direction: client->server

Data Structures

Macros

Typedefs