Struct mainline::rpc::Rpc

pub struct Rpc { /* private fields */ }

Internal Rpc called in the Dht thread loop, useful to create your own actor setup.

Implementations

impl Rpc

pub fn new(settings: &DhtSettings) -> Result<Self>

Create a new Rpc

pub fn with_id(self, id: Id) -> Self

Override the Rpc’s Id which is set randomly be default.

pub fn id(&self) -> &Id

Returns the node’s Id

pub fn local_addr(&self) -> SocketAddr

Returns the address the server is listening to.

pub fn tick(&mut self) -> RpcTickReport

Advance the inflight queries, receive incoming requests, maintain the routing table, and everything else that needs to happen at every tick.

pub fn request(&mut self, address: SocketAddr, request: RequestSpecific) -> u16

Send a request to the given address and return the transaction_id

pub fn response( &mut self, address: SocketAddr, transaction_id: u16, response: ResponseSpecific, )

Send a response to the given address.

pub fn error( &mut self, address: SocketAddr, transaction_id: u16, error: ErrorSpecific, )

Send an error to the given address.

pub fn put( &mut self, target: Id, request: PutRequestSpecific, sender: Option<Sender<PutResult>>, )

Store a value in the closest nodes, optionally trigger a lookup query if the cached closest_nodes aren’t fresh enough.

salt is only relevant for mutable values.

pub fn get( &mut self, target: Id, request: RequestTypeSpecific, sender: Option<ResponseSender>, extra_nodes: Option<Vec<SocketAddr>>, )

Send a message to closer and closer nodes until we can’t find any more nodes.

Queries take few seconds to fully traverse the network, once it is done, it will be removed from self.queries. But until then, calling rpc.query() multiple times, will just add the sender to the query, send all the responses seen so far, as well as subsequent responses.

Effectively, we are caching responses and backing off the network for the duration it takes to traverse it.

extra_nodes option allows the query to visit specific nodes, that won’t necessesarily be visited through the query otherwise.

Trait Implementations

impl Debug for Rpc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.