Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Response => ResponseHeader [MetaData] APIResponse
ResponseHeader => defined below
MetaData => Optional
APIResponse => (PutResponse | GetResponse | PutAllResponse | GetAllResponse | ServerConfigResposne | ClientConfigResponse | AuthResponse | ErrorResponse)

ResponseHeader

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) hasMetaData CorrelationIdDescription
ResponseTypeId => fixedSize = 2 bytes, type = int16 
ErrorCode => fixedSize = 2 bytes, type = int16When there is error response will have error message(String) for it
hasMetaData => fixedSize = 1 byte, type = booleanif there is any meta data associated with this request
CorrelationId => fixedSize = 4 bytes, type = int32 

...

ErrorResponse

The response will indicate the error using the fixed size error header, optional metadata and error message.

ErrorHeader => defined below
Response ErrorResponse => ErrorHeader [MetaData] errorMessage
MetaData => Optional
errorMessage => (variable size, type = String)

ErrorHeader

ErrorHeader => ErrorCode hasMetaData CorrelationIdDescription
ErrorCode => fixedSize = 2 bytes, type = int16When there is error response will have message(String) for it
hasMetaData => fixedSize = 1 byte, type = booleanif there is any meta data associated with this request
CorrelationId => fixedSize = 4 bytes, type = int32 

Value

The Value is serialized bytes for the Geode region value. It contains value header and series of bytes. Using value header, we can send a big serialized object in more than one chunk. 

...