Motivation

Implement thin Ignite client in any programming language / platform using a well-defined binary connectiona protocol.

...

Complex Objects

Complex objects consist of a 24-byte header, set of fields (binary objects), and a set of fields (key-value pairsschema (field ids and positions).

Message format

All messages, request and response, including handshake, start with int message length (excluding these first 4 bytes). E.g. empty message would be represented by 4 zero bytes.

Length is omitted in all message descriptions below for brevity.

Handshake

The first message upon connection establishment must be a handshake. Handshake ensures that client and server versions are compatible.

Client Operations

Wrapped Binary Objects

One ore more binary objects can be wrapped in an array. This allows reading, storing, passing and writing objects efficiently without understanding their contents, performing simple byte copy.

All cache operations return complex objects inside a wrapper (but not primitives).

Message format

All messages, request and response, including handshake, start with int message length (excluding these first 4 bytes). E.g. empty message would be represented by 4 zero bytes.

Length is omitted in all message descriptions below for brevity.

Handshake

The first message upon connection establishment must be a handshake. Handshake ensures that client and server versions are compatible.

Client Operations

 Upon successful handshake client can start performing operations by sending  Upon successful handshake client can start performing operations by sending a request with specific op code. Each operation has it's own request and response format, with a common header.

...

OP_CACHE_GET_ALL = 1003

Retrieves multiple values from cache given multiple keys. 

Cache flags

GET and all other cache operations include flags byte.

OP_CACHE_GET_ALL = 1003

Retrieves multiple values from cache given multiple keys. 

int

...

Cache configuration is sent and received by server in the following format:

Cache configuration is sent by server in the following format:

OP_CACHE_CREATE_WITH_CONFIGURATION = 1053

Creates cache with provided configuration. Throws an exception if the name is already in use. 

Any number of configuration properties can be provided. Name is required.

Cache configuration data is specified in key-value form, where key is `short` property id and value is property-specific data. Table below describes all available properties.

OP_CACHE_CREATE_WITH_CONFIGURATION = 1053

Creates cache with provided configuration. Throws an exception if the name is already in use. 

Empty response.

OP_CACHE_GET_OR_CREATE_WITH_CONFIGURATION = 1054

Creates cache with provided configuration. Does nothing if the name is already in use.  

Same request format as above. Empty response.

OP_QUERY_SQL = 2002

Performs SQL query. 

...

Gets the binary type information by id.id.

...

...

OP_QUERY_SCAN_CURSOR_GET_PAGE = 2001

...

var socket = openSocket("127.0.0.1:10800");
 
// Message length
socket.writeInt(8);
 
// Handshake operation
socket.writeByte(1);
 
// Protocol version 1.0.0
socket.writeShort(1);
socket.writeShort(0);
socket.writeShort(0);
 
// Client type: thin client
socket.writeByte(2);
 
// Receive result
var resLen = socket.readInt();
assert resLen == 1;  // Success message length is 1
var res = socket.readByte();
assert res == 1;  // Success code
// END HANDSHAKE
 
 
// Perform OP_CACHE_GET
// Message length
socket.writeInt(20)
 
// Op code = OP_CACHE_GET
socket.writeShort(11000);
 
// Request id (can be anything; does not matter for simple blocking socket IO)
var reqId = 1;
socket.writeLong(reqId);
 
// Cache id
var cacheName = "myCache";
var cacheId = javaHashCode(cacheName);
socket.writeInt(cacheId);
 
// Flags = none
socket.writeByte(0);
 
// Cache key 
socket.writeByte(3);  // Integer type code
socket.writeInt(1);  // Our cache value
 
// Read result
var len = socket.readInt();
assert len == 17;   // requestId (8) + status code (4) + int object (1 + 4)
 
var resReqId = socket.readLong();
assert reqId == resReqId;
 
var statusCode = socket.readInt();
assert statusCode == 0;  // Success
 
var resTypeCode = socket.readByte();
assert restypeCode == 3;  // Integer
 
var res = socket.readInt();
print(res);  // Resulting cache value

...

• https://docs.mongodb.com/manual/reference/mongodb-wire-protocol/
• http://docs.hazelcast.org/docs/protocol/1.0-developer-preview/client-protocol.html

Tickets

See "thin client" component in JIRA

...