Protocol Overview

We use binary format data for communication, protocol support both WebSocket and TCP.

info

Endianness is BigEndian

If your are familiar with Python or C++, we provider SDK for you.

If you want parse protocol by self, you can check our Go Implemetation.

The endponts of WebSocket and TCP can be found here.

Before start parse protocol, you should know our Communication Model, we split to three type of communication:

• Handshake - For establishing connection
• Request and Response - Pairing data packet for handle api request
• Push - One peer send data to another, no need response

Depends on communication model, there are out typs of packet:

• Handkeshake
• Request
• Response
• Push

Data is in the body of the packet, current we only support Protobuf for codec.

Protobuf definition can be found in:

• Control command
• Data command