THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
| ID | IEP-76 |
| Author | |
| Sponsor | |
| Created |
|
| Status | DRAFT |
Motivation
Thin client protocol will be the primary way to interact with Ignite 3.0 from code.
Description
Adapt Ignite 2.x protocol for Ignite 3.0. Main differences are:
- MsgPack as underlying binary format (IEP-75 Thin Client MsgPack Serialization)
- Different set of data types (IEP-54: Schema-first Approach)
- More flexible and extensible handshake with magic header string
TCP Socket
- Every Ignite node listens on a TCP port. Thin client implementations connect to any node in the cluster (possibly multiple nodes) through a TCP socket and perform Ignite operations using a well-defined binary protocol.
- Server-side connection parameters are defined in
ClientConnectorConfigurationclass.- Default port is 10800.
- Connector is enabled by default, no configuration changes needed.
- Netty is used on the server for network IO.
Data Format
MsgPack is used for data serialization.
Data Types Mapping
Ignite data types defined in IEP-54 map to MsgPack data types the following way:
Ignite Type | Size | MsgPack Type | Notes |
|---|---|---|---|
| Bitmask(n) | ⌈n/8⌉ bytes | bin8 / bin16 / bin32 | |
| IntX, UintX | 1-8 bytes | fixint / intX / uintX | Integer types are interchangeable when possible. fixint (1 byte) can be passed as a value for uint64 column. |
| Float | 4 bytes | float32 | |
| Double | 8 bytes | float64 | |
| Number([n]) | Variable | ext16 (up to 2^8 - 1 bytes) | Extension 1 |
| Decimal | Variable | ext16 (up to 2^8 - 1 bytes) | Extension 2 |
| UUID | 16 bytes | fixext16 | Extension 3 |
| String | Variable | str | |
| Date | 3 bytes | fixext4 | Extension 4 |
| Time | 4 bytes | fixext4 | Extension 5 |
| Datetime | 7 bytes | fixext8 | Extension 6 |
| Timestamp | 8 bytes | timestamp 64 | |
| Binary | Variable | bin32 (up to 2^32 - 1 bytes) |
"Extension X" is a MsgPack extension type (up to 128 extension types are allowed).
Message format
All messages, request and response, except handshake, start with unsigned integer message length (excluding the length itself). Any MsgPack integer type can be used, so that shorter messages use smaller type to encode length. Empty message will be single 0 byte.
| positive fixint / uint8 / uint16 / uint32 / uint64 | Length of Payload |
| ... | Payload |
Handshake
TODO: Magic word, features as map 
Risks and Assumptions
TODO
Discussion Links
- TODO
Reference Links
- IEP-75 Thin Client MsgPack Serialization
- IEP-9 Thin Client Protocol (Ignite 2.x protocol)
Tickets
Overview
Content Tools
Apps
