Attribute Macro tari_comms_rpc_macros::tari_rpc

#[tari_rpc]

#[tari_rpc(...)] proc macro attribute

Generates Tari RPC "harness code" for a given trait.

use tari_comms::{framing, memsocket::MemorySocket};

#[tari_rpc(protocol_name = b"/tari/greeting/1.0", server_struct = GreetingServer, client_struct = GreetingClient)]
pub trait GreetingRpc: Send + Sync + 'static {
    #[rpc(method = 1)]
    async fn say_hello(&self, request: Request<String>) -> Result<Response<String>, RpcStatus>;
    #[rpc(method = 2)]
    async fn return_error(&self, request: Request<()>) -> Result<Response<()>, RpcStatus>;
    #[rpc(method = 3)]
    async fn get_greetings(&self, request: Request<u32>) -> Result<Streaming<String>, RpcStatus>;
}

// GreetingServer and GreetingClient can be used
struct GreetingService;
#[tari_comms::async_trait]
impl GreetingRpc for GreetingService {
    async fn say_hello(&self, request: Request<String>) -> Result<Response<String>, RpcStatus> {
        unimplemented!()
    }

    async fn return_error(&self, request: Request<()>) -> Result<Response<()>, RpcStatus> {
        unimplemented!()
    }

    async fn get_greetings(&self, request: Request<u32>) -> Result<Streaming<String>, RpcStatus> {
        unimplemented!()
    }
}

fn server() {
    let greeting = GreetingServer::new(GreetingService);
    let server = RpcServer::new().add_service(greeting);
    // CommsBuilder::new().add_rpc(server)
}

async fn client() {
    // Typically you would obtain the client using `PeerConnection::connect_rpc`
    let (socket, _) = MemorySocket::new_pair();
    let mut client = GreetingClient::connect(framing::canonical(socket, 1024)).await.unwrap();
    let _ = client.say_hello("Barnaby Jones".to_string()).await.unwrap();
}

tari_rpc options

• protocol_name is the value used during protocol negotiation
• server_struct is the name of the "server" struct that is generated
• client_struct is the name of the client struct that is generated

rpc attribute

• method is a unique number that uniquely identifies each function within the service. Once a method is used it should never be reused (think protobuf field numbers).