tari_comms 5.3.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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//  Copyright 2020, The Tari Project
//
//  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
//  following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
//  disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//  following disclaimer in the documentation and/or other materials provided with the distribution.
//
//  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
//  products derived from this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
//  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//! # RPC protocol
//!
//! Provides a request/response protocol that supports streaming.
//! Available with the `rpc` crate feature.

#[cfg(test)]
mod test;

/// Maximum frame size of each RPC message. This is enforced in tokio's length delimited codec.
/// This can be thought of as the hard limit on message size.
pub const RPC_MAX_FRAME_SIZE: usize = 6 * 1024 * 1024; // 6 MiB

/// The maximum request payload size
const fn max_request_size() -> usize {
    RPC_MAX_FRAME_SIZE
}

/// The maximum size for a single RPC response body excluding response header overhead
const fn max_response_payload_size() -> usize {
    // RpcResponse overhead is:
    // - 4 varint protobuf fields, each field ID is 1 byte
    // - 3 u32 fields, VarInt(u32::MAX) is 5 bytes
    // - 1 length varint for the payload, allow for 5 bytes to be safe (max_payload_size being technically too small is
    //   fine, being too large isn't)
    const MAX_HEADER_SIZE: usize = 4 + 4 * 5;
    RPC_MAX_FRAME_SIZE - MAX_HEADER_SIZE
}

mod body;
pub use body::{Body, ClientStreaming, IntoBody, Streaming};

mod context;

mod server;
pub use server::{NamedProtocolService, RpcServer, RpcServerBuilder, RpcServerError, RpcServerHandle, mock};

mod client;
pub use client::{
    RpcClient,
    RpcClientBuilder,
    RpcClientConfig,
    pool,
    pool::{RpcClientLease, RpcClientPool, RpcClientPoolError, RpcPoolClient},
};

mod either;

mod message;
pub use message::{Request, Response};

mod error;
pub use error::RpcError;

mod handshake;
pub use handshake::{Handshake, RpcHandshakeError};

mod status;
pub use status::{RpcStatus, RpcStatusCode, RpcStatusResultExt};

mod not_found;

// Re-exports used to keep things orderly in the #[tari_rpc] proc macro
pub mod __macro_reexports {
    pub use futures::{future, future::BoxFuture};
    pub use tokio::io::{AsyncRead, AsyncWrite};
    pub use tower::Service;

    pub use crate::{
        Bytes,
        framing::CanonicalFraming,
        protocol::{
            ProtocolId,
            rpc::{
                Body,
                ClientStreaming,
                IntoBody,
                RpcClient,
                RpcClientBuilder,
                RpcError,
                RpcStatus,
                message::{Request, Response},
                pool::RpcPoolClient,
                server::{NamedProtocolService, RpcServerError},
            },
        },
        stream_id::StreamId,
    };
}