Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• string Field = 1

• string Field = 1

• uint64 SenderPeerID = 1

• int64 Timestamp = 2

  Timestamp is used to metric the latency between two peers.

• uint64 SrcPeerID = 1

• uint64 DstPeerID = 2

• uint32 Nonce = 3

• bytes Fragment = 4

• bytes Message = 1

  Credentials encrypted by the shared key. The shared key generated by the noise protocol. Workflow: 1. Client fetch its primary server information from portal service. 2. Client handshake with relay server and put the credentials into HandshakeMessage.

• bool IsPrimary = 2

  IsPrimary indicates whether is the destination relay server the primary server of client.

• bytes Message = 1

• int64 Timestamp = 1

• repeated uint64 Peers = 1

• repeated uint64 OnlinePeers = 1

• repeated uint64 OfflinePeers = 2

• uint64 DstPeerID = 1

• PacketSyncPeer.Purpose purpose = 2

• optional PacketSyncPeer.PeerInfo Peer = 3

  Only be assigned a value if the purpose is

• repeated string endpoints = 4

  Only be assigned a value if the purpose is `PairRequest/PairResponse/EndpointsChanged`

Used in: PeerInfo

• string Name = 1

• uint64 ID = 2

Used in: PacketSyncPeer

• uint64 PeerID = 1

• uint64 UserID = 2

• string Name = 3

• string IPv4 = 4

• bytes PublicKey = 5

• optional RelayServer PrimaryServer = 6

• repeated Network Networks = 7

Used in: PacketSyncPeer

• Undefined = 0

• Catchup = 1

  Catch up is used to synchronize the peer endpoints information between peers. All new startup device will retrieve the peers list and send `PacketSyncEndpoints` with the `Catchup` purpose message for all online devices.

• CatchupAck = 2

• PairRequest = 3

  All message communication via relay server by default and the `PairRequest/PairResponse` purpose will try to establish P2P connection between peers.

• PairResponse = 4

• EndpointsChanged = 5

Used in: PeerInfo

• uint64 ID = 1

• string Name = 2

• string Region = 3

• string Host = 4

• uint32 Port = 5

• string PublicKey = 6

• Handshake = 0

  Handshake packet is use to handshake with the relay server. The handshake message should be the first message between relay server and peer client. The message is used to exchange the DH key and generate the shared key for the subsequence messages. The subsequence messages will not be handled by the relay server if the handshake has not completed.

  DIRECTION: peer -> relay server (TCP)

• HandshakeAck = 1

  DIRECTION: relay server -> peer (TCP)

• ProbeRequest = 2

  Probe packet is used to probe if peers connected to the relay server.

  DIRECTION: peer -> relay server (TCP)

• ProbeResponse = 3

  DIRECTION: relay server -> peer (TCP)

• Heartbeat = 4

  Heartbeat packet is used to keep alive between PairMesh node and relay servers

  DIRECTION: peer <-> relay server

• SyncPeer = 5

  SyncPeer packet is used to synchronize the peer information between PairMesh nodes.

  DIRECTION: peer <-> relay server <-> peer (TCP)

• Forward = 6

  Forward represents the relay message which is forwarded by the relay server.

  DIRECTION: peer -> relay server -> peer (TCP)

• Discovery = 7

  PEER MESSAGE: UDP packet between peers.

  DIRECTION: peer -> peer (UDP)

• Fragment = 8

  PEER MESSAGE: UDP packet the raw IP fragment red from virtual network device.

  DIRECTION: peer -> peer (UDP)

• _UnitTestRequest = 99

• _UnitTestResponse = 100