THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Message definition grammar
In order to consistently define messages the Extended Backus–Naur form grammar will be used.
Usage | Notation |
|---|---|
| definition | = |
| alteration | | |
| optional | [ ... ] |
| repetition | { ... } |
| Grouping | ( ... ) |
Generic Message definition
...
| Message = MessageHeader (Request | Response) | Description | |
|---|---|---|
| MessageHeader | variable size, type = MessageHeader | The MessageHeader corresponding to this Message. |
| Request | variable size, type = Request | This field will contain the Request component. |
| Response | variable size, type = Response | This field will contain the Response component. |
...
| MessageHeader = Size CorrelationId isPartialMessage hasMetaData | Description | |
|---|---|---|
| Size | fixedSize = 4 bytes, type = int32 | Size of request or response |
| CorrelationId | fixedSize = 4 bytes, type = int32 | The correlationID used to track a request/response |
| isPartialMessage | fixedSize = 1 byte, type = boolean | Is this a partial message? |
| hasMetaData | fixedSize = 1 byte, type = boolean | Does the message have meta data associated with it |
...
The request would contain the fixed size request header, optional metadata and request API parameters.
Request = RequestHeader [MetaData] RequestAPI | Notes | Description | RequestHeader | variable size, type = RequestHeader | The RequestHeader corresponding to this Request
|---|---|---|
| MetaData | optional, variable size, type = MetaData | This field is optional and will be populated if the MessageHeader.hasMeta is true |
RequestAPI | variable size, type = variable | The Api specific Request message. Here are some examples of Request messages. PutRequest | GetRequest | PutAllRequest | GetAllRequest |ServerConfigRequest | ClientConfigRequest | AuthRequest |
RequestHeader
The request header contains the ApiId, ApiVersion, and hasMetaData flag to indicate whether the request contains some metadata.
| Description | ||
|---|---|---|
| ApiId | fixedSize = 2 bytes, type = int16 | The Api ID for the Request. Supported ID's are defined on the API's page |
| apiVersion | fixedSize = 1 byte, type = int8 | The version of the API being used. |
Response
The response would will contain the fixed size response header, optional metadata and return values.
| Response = ResponseHeader [MetaData] APIResponse | Description | |
|---|---|---|
| ResponseHeader | variable size, type = ResponseHeader | The ResponseHeader corresponding to this Response |
| MetaData | optional, variable size, type = MetaData | This field is optional and will be populated if the MessageHeader.hasMeta is true |
| APIResponse | variable size, type = variable | The Api specific Reponse message. Here are some examples of Response messages PutResponse | GetResponse | PutAllResponse | GetAllResponse | ServerConfigResposne | ClientConfigResponse | AuthResponse | ErrorResponse |
...
The response header will have resposneType, which indicates its partial response, full response or error. A hasMetaData flag indicates whether the response contains some metadata.
| ResponseHeader = ResponseTypeId | ErrorCode | Description | |
|---|---|---|
| ResponseTypeId | fixedSize = 2 bytes, type = int16 | The ResponeTypeId corresponding to either a Full or Partial message |
| ErrorCode | fixedSize = 2 bytes, type = int16 | The error code for the error that occurred. A list of error codes can be found on the page Error Codes |
ErrorResponse
The server will raise the error when it failed to execute API request from the client. The error code and message should help the client to diagnose the issue.
| ErrorResponse = errorMessage | Description | |
|---|---|---|
| errorMessage | variable size, type = String | The error message |
...
| Value = {ValueHeader value} | Description | |
|---|---|---|
| ValueHeader | variable size, type = ValueHeader | The ValueHeader corresponding to this Value entry |
| value | variable size, type = bytes | Serialized Value Object which Geode can understand |
...
| ValueHeader = Size hasPartialBytes | Description | |
|---|---|---|
| Size | fixedSize = 4 bytes, type = int32 | Number of serialized bytes |
| hasPartialBytes | fixedSize = 1 byte, type = boolean | Whether this contains partial bytes of value |
...
| MetaData = NumberOfMetadata { MetadataKeyId MetadataKeyValue} | Description | |
|---|---|---|
| NumberOfMetadata | fixedSize = 2 bytes, type = int16 | The number of MetaDataKeyId : MetaDataKeyValue combinations |
| MetadataKeyId | fixedSize = 2 bytes, type = int16 | Supported MetaDataKeyId's can be found in the table "Supported MetaData - MetaData KeyId" |
| MetadataKeyValue | variable size, type = variable | The MetaData value for the KeyId. The supported dataType can be found in the table "Supported MetaData - MetaData Value Type" |
...
Request MetaData Key | MetaData KeyId | MetaData Value example | MetaData Value Type | Description |
|---|---|---|---|---|
| JSON_KEY | 1 | true | fixedSize = 1 byte, type = boolean | Geode will expect key as JSON string(or bytes) and it will convert that string into PDX key. If the response requires a key, then it will convert the PDX key to JSON string(or bytes) back. |
| JSON_VALUE | 2
| true | fixedSize = 1 byte, type = boolean | Geode will expect Value as JSON string(or bytes) and it will convert that string into PDX value. If the response requires a value, then it will convert PDX value to JSON string(or bytes) back. |
| EVENT_ID | 3
| EventId { uniqueId: type = String ThreadId:type=int64 SequenceId: type=int64 } | variable size, type = bytes | The eventid is used to identify same region event in Geode. Geode keeps map of "uniqueId + threadId" Vs "SequenceId" to know whether region event has been already seen or not.
|
...
Response MetaData Key | MetaData KeyId | MetaData Value example | MetaData Value Type | Description |
|---|---|---|---|---|
| UPDATE_PR_META_DATA | 1 | true | fixedSize = 1 byte, type = boolean | [optional]The server accepted and forwarded the request to the appropriate node holding the affected cache entry. A smart client should refresh its partitioned region location metadata for higher performance. |