[This is preliminary documentation and is subject to change.]
This class provides facilities for reading and writing the messages
which are exchanged between a Persistate Server and a Persistate Viewer or web
session.
Declaration Syntax| C# |
[SerializableAttribute] public class Message
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | Message(MessageType) | Creates a new empty writable Message with a particular MessageType and the default initial
capacity. Used when writing messages to a stream. |
| Message(MessageType, Int32) | Creates a new empty writable Message with with a particular MessageType and a particular initial
capacity. Used when writing messages to a stream. |
| Message(MessageType, array<Byte>[]()[][]) |
Creates a new message of a particular type holding preset data.
|
| Append(Boolean) | Appends a single boolean value to this message. |
| Append(Int32, Boolean) | Appends a slot number, a length field, and a single boolean value
to this message. |
| Append(Byte) | Appends a single byte value to this message. |
| Append(Int32, Byte) | Appends a slot number, a length field, and a single byte value to
this message. |
| Append(Char) | Appends a single char value to this message. |
| Append(Int32, Char) | Appends a slot number, a length field, and a single char value to
this message. |
| Append(Int16) | Appends a single short value to this message. |
| Append(Int32, Int16) | Appends a slot number, a length field, and a single short value
to this message. |
| Append(Int32) | Appends a single int value to this message. |
| Append(Int32, Int32) | Appends a slot number, a length field, and a single int value to
this message. |
| Append(Int64) | Appends a single long value to this message. |
| Append(Int32, Int64) | Appends a slot number, a length field, and a single long value to
this message. |
| Append(Single) | Appends a single float value to this message. |
| Append(Int32, Single) | Appends a slot number, a length field, and a single float value
to this message. |
| Append(Double) | Appends a single double value to this message. |
| Append(Int32, Double) | Appends a slot number, a length field, and a single double value
to this message. |
| Append(Decimal) | Appends a single decimal value to this message. |
| Append(Int32, Decimal) | Appends a slot number, a length field, and a single decimal value
to this message. |
| Append(DateTime) | Appends a single DateTime value to this message. |
| Append(Int32, DateTime) | Appends a slot number, a length field, and a single DateTime
value to this message. |
| Append(String) | Appends a string to this message. |
| Append(Int32, String) | Appends a slot number, a length field, and a string to this
message. |
| Append(IReference) | Appends a single Reference value to this message.
|
| Append(Int32, IReference) | Appends a slot number, a length field, and a single Reference value to this message. |
| Append(array<Byte>[]()[][]) | Appends a byte array to this Message. |
| Append(Int32, array<Byte>[]()[][]) | Appends a slot number, a length field, and a byte array to this
Message. |
| Append(PFont) | Appends a single Font value to this message. |
| Append(Int32, PFont) | Appends a slot number, a length field, and a single Font value to
this message. |
| Append(PColor) | Appends a single Color value to this message. |
| Append(Int32, PColor) | Appends a slot number, a length field, and a single Color value
to this message. |
| Append(PImage) | Appends a single Image to this message. |
| Append(Int32, PImage) | Appends a slot number, a length field, and a single Image value
to this message. |
| AppendIClassified(IClassified) | Appends metadata or data for an IClassified item to
the message. |
| AppendIClassified(Int32, IClassified) | Appends a slot number, a length field, and metadata or data for
an IClassified item to the message. |
| AppendObject(Persistent) | Appends a Persistent object to the message.
|
| AppendObject(Int32, Persistent) | Appends a slot number, a length field, and a Persistent object to
the message. |
| AppendVariant(Object) | Appends the value of an object to this message. |
| AppendVariant(Int32, Object) | Appends a slot number, a length field, and the value of an object
to this message. |
| Compress()()()() | Compresses the data in the Message. |
| Decompress()()()() |
Decompresses the data in this Message.
|
| DecompressToClone()()()() | Clones this Message and then Decompresses the clone, leaving this Message
unchanged. |
| Equals(Object) | (Inherited from Object.) |
 | Finalize()()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
 | HasAvailable | Gets a value indicating whether there is more data to be read
from this message; |
| Length | Gets the Length of this message. This is the total number of
bytes that the message will require when transmitted in a Stream. This is
the data length (in data array) plus overhead of type int and data length
int. |
| MemberwiseClone()()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
| PeekInt64()()()() | Reads a single long value from this Message, without advancing
the read position. |
| PeekIReference()()()() | Reads a single Reference value from this Message
without advancing the read position. |
 | Read(Stream) | Creates a new Message read from a Stream, if one is available.
|
| ReadBoolean()()()() | Reads a single boolean value from this Message. |
| ReadByte()()()() | Reads a single byte value from this Message. |
| ReadBytes()()()() | Reads a byte array from the Message. |
| ReadChar()()()() | Reads a single char value from this Message. |
| ReadCoercedString()()()() | Reads a single String value from this Message. |
| ReadDateTime()()()() | Reads a single DateTime value from this Message. |
| ReadDecimal()()()() | Reads a single decimal value from this Message. |
| ReadDouble()()()() | Reads a single double value from this Message. |
| ReadIClassified()()()() | Reads metadata for an IClassified item from the
message, and retrieves the item. |
| ReadInt16()()()() | Reads a single short value from this Message. |
| ReadInt32()()()() | Reads a single int value from this Message. |
| ReadInt64()()()() | Reads a single long value from this Message. |
| ReadIReference()()()() | Reads a single Reference value from this Message.
|
| ReadObject()()()() | Reads a Persistent object from the message.
|
| ReadObject(Boolean, Persistent) | Reads a Persistent object from the message.
|
| ReadObject(Boolean, Persistent, Persistent) | Reads a Persistent object from the message.
|
| ReadPColor()()()() | Reads a single Color value from this Message. |
| ReadPFont()()()() | Reads a single Font value from this Message. |
| ReadPImage()()()() | Reads a single Image from this Message. |
| ReadSingle()()()() | Reads a single float value from this Message. |
| ReadString()()()() | Reads a single string value from this Message. |
| ReadVariant()()()() | Reads the value of an object from this message. |
| SkipBytes(Int32) | Skips over a number of bytes in this Message. |
| ToString()()()() |
Creates a string representation of the Message for logging purposes
(Overrides Object.ToString()()()().) |
| Write(Stream) | Writes this message to a stream. |
RemarksMessage serialises data in an efficient binary format. It is
unlikely that developers will need to use this class directly.
Inheritance Hierarchy| Object | |
 | Message |