 | Message Class |
Unit of communication between endpoints in a NetSwitch network.
Inheritance HierarchyNamespace: OBCOM.NetSwitchLib.Messages
Assembly: OBCOM.NetSwitchLib (in OBCOM.NetSwitchLib.dll) Version: 1.48.7760.35650 (1.48.7760.35650)
SyntaxThe Message type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Message |
Constructs a new Message instance.
|
| Message(Byte) |
Constructs a new Message with supplied bytes.
|
| Message(Object) |
Constructs a new Message with supplied odata.
|
| Message(String) |
Constructs a new Message with supplied text.
|
| Message(Type) |
Constructs a new Message with supplied type.
|
Properties| Name | Description | |
|---|---|---|
 | Bytes |
Gets or sets the bytes data of this Message.
|
| Status |
Gets or sets the status of this Message.
|
| Text |
Gets or sets the string data of this Message.
|
| Type |
Gets or sets the type of this Message.
|
Methods| Name | Description | |
|---|---|---|
| Clear |
Resets all the fields of this Message to their default value.
|
| ClearLabels |
Removes all defined labels from this Message.
|
| ClearProperties |
Removes all defined properties from this Message.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FromStream |
Decodes all the fields of this Message from supplied stream.
|
| GetBoolean |
Returns the boolean value of the property indexed by name.
|
| GetByte |
Returns the byte value of the property indexed by name.
|
| GetBytes |
Returns the bytes value of the property indexed by name.
|
| GetDate |
Returns the date value of the property indexed by name.
|
| GetDecimal |
Returns the decimal value of the property indexed by name.
|
| GetDouble |
Returns the double value of the property indexed by name.
|
| GetFloat |
Returns the float value of the property indexed by name.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetInteger |
Returns the integer value of the property indexed by name.
|
| GetLabel |
Returns the value of the label indexed by key.
|
| GetLabelKeys |
Returns a read-only collection with all defined label keys.
|
| GetLong |
Returns the long value of the property indexed by name.
|
| GetObjectT |
Returns the object containing the data of this Message.
|
| GetObjectT(String) |
Returns the object value of the property indexed by name.
|
| GetProperties |
Returns a read-only dictionary with all defined properties.
|
| GetPropertyNames |
Returns a read-only collection with all defined property names.
|
| GetShort |
Returns the short value of the property indexed by name.
|
| GetText |
Returns the string value of the property indexed by name.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasLabel |
Returns true if the label indexed by key is defined.
|
| HasProperty |
Returns true if the property with name is defined.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PutBoolean |
Changes the boolean value of the property indexed by name. If value is null the
property is removed.
|
| PutByte |
Changes the byte value of the property indexed by name. If value is null the
property is removed.
|
| PutBytes |
Changes the bytes value of the property indexed by name. If value is null the
property is removed.
|
| PutDate |
Changes the date value of the property indexed by name. If value is null the
property is removed.
|
| PutDecimal |
Changes the big decimal value of the property indexed by name. If value is null the
property is removed.
|
| PutDouble |
Changes the double value of the property indexed by name. If value is null the
property is removed.
|
| PutFloat |
Changes the float value of the property indexed by name. If value is null the
property is removed.
|
| PutInteger |
Changes the integer value of the property indexed by name. If value is null the
property is removed.
|
| PutLabel |
Changes the value of the label indexed by key.
|
| PutLong |
Changes the long value of the property indexed by name. If value is null the
property is removed.
|
| PutObject(Object) |
Changes the object containing the data of this Message.
|
| PutObject(String, Object) |
Changes the object value of the property indexed by name. If value is null the
property is removed.
|
| PutProperties |
Copies all the properties of the message to this Message.
|
| PutShort |
Changes the short value of the property indexed by name. If value is null the
property is removed.
|
| PutText |
Changes the string value of the property indexed by name. If value is null the
property is removed.
|
| RemoveLabel |
Removes the label indexed by supplied key.
|
| RemoveProperty |
Removes the property indexed by name.
|
| ToStream |
Encodes all the fields of this Message into a Stream.
|
| ToString |
Returns a string representation of this Message.
(Overrides ObjectToString.) |
 | ValueOf |
Returns a Message built using the supplied object data.
|
Fields| Name | Description | |
|---|---|---|
 | ERROR |
Completion status indicating error.
|
| HEADER_LEN |
Number of bytes used by a Message header.
|
| SUCCESS |
Completion status indicating success.
|
RemarksA Message is composed of the following required and optional fields:
- A required message Type: used by the communication protocol.
- A required status code: indicates successful or error completion.
- An optional set of labels: used by the communication protocol.
- An optional text value: used to send a unicode string such as XML content.
- An optional bytes value: used to send an array of bytes such as a PDF file.
- An optional object value: used to send a {@link Serializable} object.
- An optional set of properties: used to send a set of name-value pairs.
Warning: a Message is not synchronized. If multiple threads access a Message instance concurrently, and at least one of the threads modifies the Message, it should be synchronized externally. This is typically accomplished by synchronizing on some object that naturally encapsulates the Message
.See Also