tari_comms 5.2.1

A peer-to-peer messaging system
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

// Copyright 2022 The Tari Project
// SPDX-License-Identifier: BSD-3-Clause

syntax = "proto3";

package tari.comms.rpc;

// Message type for all RPC requests
message RpcRequest {
    // An identifier that is unique per request per session. This value is not strictly needed as
    // requests and responses alternate on the protocol level without the need for storing and matching
    // request IDs. However, this value is useful for logging.
    uint32 request_id = 1;
    // The method identifier. The matching method for a given value is defined by each service.
    uint32 method = 2;
    // Message flags. Currently this is not used for requests.
    uint32 flags = 3;
    // The length of time in seconds that a client is willing to wait for a response
    uint64 deadline = 4;

    // The message payload
    bytes payload = 10;
}

// Message type for all RPC responses
message RpcResponse {
    // The request ID of a prior request.
    uint32 request_id = 1;
    // The status of the response. A non-zero status indicates an error.
    uint32 status = 2;
    // Message flags. Currently only used to indicate if a stream of messages has completed.
    uint32 flags = 3;

    // The message payload. If the status is non-zero, this contains additional error details.
    bytes payload = 10;
}

// Message sent by the client when negotiating an RPC session. A server may close the substream if it does
// not agree with the session parameters.
message RpcSession {
    // The RPC versions supported by the client
    repeated uint32 supported_versions = 1;
}

message RpcSessionReply {
    oneof session_result {
        // The RPC version selected by the server
        uint32 accepted_version = 1;
        // Indicates the server rejected the session
        bool rejected = 2;
    }
    enum HandshakeRejectReason {
        HANDSHAKE_REJECT_REASON_UNKNOWN = 0;
        HANDSHAKE_REJECT_REASON_UNSUPPORTED_VERSION = 1;
        HANDSHAKE_REJECT_REASON_NO_SERVER_SESSIONS_AVAILABLE = 2;
        HANDSHAKE_REJECT_REASON_NO_CLIENT_SESSIONS_AVAILABLE = 3;
        HANDSHAKE_REJECT_REASON_PROTOCOL_NOT_SUPPORTED= 4;
    }
    HandshakeRejectReason reject_reason = 3;
}