Field data for a Message which consists of a status. This is the status of the Message. This status indicates the success or failure of the command being acknowledged.
More...
|
| Message.State | getValue () |
| | This returns the value of this status field as an integer status code. More...
|
| |
| void | setValue (Message.State v) |
| | Sets the value of this status field using the specified status code integer. More...
|
| |
| | Field () |
| | Default construntotor. More...
|
| |
| | Field (string value) |
| | Constructs an instance with the bytes of the specified string value. The string is interpreted as the UTF-8 representation. More...
|
| |
| | Field (byte[] buffer, int position, int length) |
| | Constructs an instance with the specified region of a byte buffer. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance. More...
|
| |
| void | set (byte[] buffer, int position, int length) |
| | Sets the value of this instance with the specified region of a byte buffer. Note: the bytes are not copied from the buffer. The specified buffer region is referenced by this instance. More...
|
| |
| void | set (byte[] buffer) |
| | Sets the value of this instance with the specified buffer. Note: the bytes are not copied from the buffer. The buffer is referenced by this instance. More...
|
| |
| bool | isNull () |
| | Indicates whether this instance's value is null. More...
|
| |
| void | reset () |
| | Resets the value of this instance to null. More...
|
| |
| byte | byteAt (int i) |
| | Returns the byte at position plus index i. More...
|
| |
| override bool | Equals (Object obj) |
| | Default implementation for Object#equals for a Field. For two Fields to be considered equal, their values must have the same length and all bytes in the value must be equal. More...
|
| |
| override int | GetHashCode () |
| | Gets the hash code for the Field. More...
|
| |
| Field | copy () |
| | Constructs a new Field and sets its value to a deep copy of this instance. More...
|
| |
| virtual void | copyFrom (Field f) |
| | Provides a way to make this object a duplicate of f. More...
|
| |
|
| static String | encodeStatus (Message.State s) |
| | Utility method that takes a status code integer and returns the associated descriptive text. Returns "none" if the integer code is not known. More...
|
| |
|
|
const String | LATIN1 = "ISO-8859-1" |
| |
|
const byte | LATIN1_ZERO = 48 |
| |
|
|
byte[] | buffer = null |
| |
|
int | position = 0 |
| |
|
int | length = 0 |
| |
Field data for a Message which consists of a status. This is the status of the Message. This status indicates the success or failure of the command being acknowledged.
| static String AMPS.Client.Fields.StatusField.encodeStatus |
( |
Message.State |
s | ) |
|
|
inlinestatic |
Utility method that takes a status code integer and returns the associated descriptive text. Returns "none" if the integer code is not known.
- Parameters
-
| s | The status code integer to be encoded. |
- Returns
- The descriptive text status.
This returns the value of this status field as an integer status code.
- Returns
- The value of this status field as an integer status code.
Sets the value of this status field using the specified status code integer.
- Parameters
-
| v | The status code integer. |
The documentation for this class was generated from the following file:
- AMPS.Client/Fields/StatusField.cs