muxio 0.3.0-alpha

Toolkit for layered stream multiplexing and schema-less RPC communication
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

use crate::rpc::rpc_internals::RpcMessageType;

/// Represents the header of an RPC (Remote Procedure Call) message.
#[derive(Debug, Clone)]
pub struct RpcHeader {
    /// The type of the RPC message (Call, Response, Event, etc.).
    pub msg_type: RpcMessageType,

    /// A unique identifier for this RPC message. It helps correlate requests and responses.
    ///
    /// For example:
    /// - For a call, this ID could represent the unique request ID.
    /// - For a response, this ID would match the request ID for which it is responding.
    pub id: u32, // TODO: Rename... it's vague.

    /// The identifier (or hash) of the method being invoked in this RPC.
    ///
    /// This field helps to identify which method is being called in the remote procedure.
    /// It's often hashed to ensure uniqueness and prevent collisions in method names.
    pub method_id: u64, // TODO: Rename to `method_hash`?

    // TODO: Document; Schema-less metadata
    pub metadata_bytes: Vec<u8>,
}