Type/Status Reference
Type Table
The types table describes the types used the Match Server Protocol. The width in bits is included for the binary protocol.
| Name | Width (bits) | Description |
|---|---|---|
| byte_order_mark | 16 | Specifies the requested byte order by sending 0xAABB in that byte order. The Match Server supports big-endian and little-endian byte order. The characters 'TX' (0x5458) are used as an escape to switch to text protocol. |
| version | 32 | Specifies the version of the Match Server protocol. The current version number is 200803. |
| command | 8 | A command number (used in the binary protocol) |
| status_code | 8 | The status code from a command. |
| dimension | 16 | The number of a dimension in a Semantic Signature®. |
| weight | 32 | The weight of a dimension in a Semantic Signature® or of a result from a match query. This value should be divided by the result factor to get the correct floating point value (weights are usually between 0 and 1). |
| ID | 32 | The ID of a signature in the index. |
| row_count | 32 | The number of rows in a request or response, the rows follow the row_count value. The contents of the rows are defined by the command. |
| length | 32 | A generic length which must be >= 0. |
| time | 32 | See the update_time command. |
Status Table
The status table describes the meaning of the status codes returned from certain commands in the Match Server Protocol. Status codes are of type status_code.
| Name | Number | Description |
|---|---|---|
| OK | 0 | Indicates that the command completed successfully. |
| NOT_FOUND | 1 | Indicates that the command failed because the specified signature could not be found. |
| INVALID | 2 | Indicates that the parameters provided are not valid for the command. |
