![]() |
Diffusion .NET Classic API - Core and Common
5.9.4
|
This is the base class for all Diffusion messages. More...
Public Member Functions | |
abstract bool | IsTopicMessage () |
virtual bool | IsAckRequired () |
abstract void | SetHeaders (params string[] headers) |
Sets user-defined headers. One or more separate headers may be set as required. Headers may be set once and only once after constructing a message and before any data is added to the message. More... | |
abstract void | SetHeaders (List< string > headers) |
abstract List< string > | GetHeaders () |
Returns a list of user-defined headers. More... | |
abstract string | GetHeader (int index) |
Returns a header value. More... | |
virtual int | Size () |
abstract int | Capacity () |
This returns the capacity of the message. More... | |
abstract int | CompareTo (IMessage message) |
Compares the current object with another object of the same type. More... | |
abstract int | CompareTo (IMessage message, MessageComparator comparator) |
Compares this message to another message using a specified comparator. More... | |
Static Public Attributes | |
static byte | MESSAGE_DELIMITER |
Message delimiter. More... | |
static char | MESSAGE_DELIMITER_CHAR = (char) 0x00 |
Message delimiter character. More... | |
static byte | RECORD_DELIMITER = 0x01 |
Record delimiter. More... | |
static char | RECORD_DELIMITER_CHAR = (char) 0x01 |
Record delimiter character. More... | |
static byte | FIELD_DELIMITER = 0x02 |
Field delimiter. More... | |
static char | FIELD_DELIMITER_CHAR = (char) 0x02 |
Field delimiter character. More... | |
static byte | MESSAGE_SEPARATOR = 0x08 |
Message separator. More... | |
static char | MESSAGE_SEPARATOR_CHAR = (char) 0x08 |
Message separator character. More... | |
static char | EMPTY_FIELD_CHAR = (char) 0x03 |
Empty field character. More... | |
static string | EMPTY_FIELD_STRING = EMPTY_FIELD_CHAR.ToString(CultureInfo.InvariantCulture) |
Empty field string. More... | |
static byte | LIST_DELIMITER = 0x06 |
Byte value reserved for use as a list delimiter used for separating the elements of a list in character-based messages. More... | |
static char | LIST_DELIMITER_CHAR = (char) LIST_DELIMITER |
Character representation of LIST_DELIMITER. More... | |
static string | LIST_DELIMITER_STRING = LIST_DELIMITER_CHAR.ToString(CultureInfo.InvariantCulture) |
String representation of LIST_DELIMITER. Useful for string.Join operations. More... | |
Properties | |
abstract long | Timestamp [get, set] |
abstract bool | IsLocked [get, set] |
This is the base class for all Diffusion messages.
|
pure virtual |
This returns the capacity of the message.
This is the maximum size that the message may reach (in bytes) including any headers.
Implemented in PushTechnology.DiffusionCore.Messaging.DataMessageImpl.
|
pure virtual |
Compares the current object with another object of the same type.
message | An object to compare with this object. |
Implemented in PushTechnology.DiffusionCore.Messaging.MessageImpl, and PushTechnology.DiffusionCore.Messaging.Topic.TopicMessageImpl.
|
pure virtual |
Compares this message to another message using a specified comparator.
message | |
comparator |
Implements PushTechnology.DiffusionCore.Messaging.IMessageComparable.
Implemented in PushTechnology.DiffusionCore.Messaging.MessageImpl.
|
pure virtual |
Returns a header value.
index | The header index (first header has index 0) |
Implemented in PushTechnology.DiffusionCore.Messaging.MessageImpl.
|
pure virtual |
Returns a list of user-defined headers.
Implemented in PushTechnology.DiffusionCore.Messaging.MessageImpl.
|
virtual |
|
pure virtual |
Sets user-defined headers. One or more separate headers may be set as required. Headers may be set once and only once after constructing a message and before any data is added to the message.
headers | A list of user-defined header values. |
Implemented in PushTechnology.DiffusionCore.Messaging.DataMessageImpl, and PushTechnology.DiffusionCore.Messaging.MessageImpl.
|
pure virtual |
Sets user-defined headers. One or more separate headers may be set as required. Headers may be set once and only once after constructing a message and before any data is added to the message.
headers | A list of user-defined header values. |
Implemented in PushTechnology.DiffusionCore.Messaging.DataMessageImpl, and PushTechnology.DiffusionCore.Messaging.MessageImpl.
|
virtual |
Reimplemented in PushTechnology.DiffusionCore.Messaging.DataMessageImpl.
|
static |
Empty field character.
|
static |
Empty field string.
|
static |
Field delimiter.
|
static |
Field delimiter character.
|
static |
Byte value reserved for use as a list delimiter used for separating the elements of a list in character-based messages.
|
static |
Character representation of LIST_DELIMITER.
|
static |
String representation of LIST_DELIMITER. Useful for string.Join operations.
|
static |
Message delimiter.
|
static |
Message delimiter character.
|
static |
Message separator.
|
static |
Message separator character.
|
static |
Record delimiter.
|
static |
Record delimiter character.
|
getset |
|
getset |