Crate rpc_pb

Source
Expand description

§rpc_pb

rpc_pb provides prototk definitions for an RPC layer.

§Status

Maintenance track. The library is considered stable and will be put into maintenance mode if unchanged for one year. Documentation changes excepted.

§Scope

This library contains everything necessary to define the wire format of the RPCs requests, responses, and frames.

§Warts

  • The library is not documented yet. We will document it when the library implementing RPC drives any final changes.

§Documentation

The latest documentation is always available at docs.rs.

Macros§

client_method
Create a client method.
server_methods
Generate the server call method.
service
Create typed server/client methods.

Structs§

ClientID
A one_two_eight identifier.
Context
A context passed by the RPC server into a service.
Frame
Messages on the wire are preceded by frames. Frames are framed by a solitary varint.
Host
A Host captures a process-unique, stable identifier with its connection string.
HostID
A one_two_eight identifier.
Request
A request to a server.
Response
A response to a client.
ServerRegistry
A ServerRegistry multiplexes servers to dispatch calls by server name.
TraceID
A one_two_eight identifier.

Enums§

Error
RPC Error.

Constants§

MAX_BODY_SIZE
The maximum body size.
MAX_REQUEST_SIZE
The maximum request size allowed.
MAX_RESPONSE_SIZE
The maximum response size allowed.

Traits§

Client
A Client is an object that can be called.
IoToZ
IO to Z.
Resolver
A trait for resolving hosts.
Server
A Server is an object that can be called.

Type Aliases§

Status
A status represents the return value of an RPC function.