diff options
| author | Trinity Pointard <trinity.pointard@gmail.com> | 2021-03-22 00:00:09 +0100 |
|---|---|---|
| committer | Trinity Pointard <trinity.pointard@gmail.com> | 2021-04-06 05:26:36 +0200 |
| commit | 7d3a95183658afea1aeb0cbd435bdec4ebfc71e8 (patch) | |
| tree | c12c1079617112c90bd47d3240587ebb54bdaf9b /src/rpc/rpc_server.rs | |
| parent | f4bf9876278ff59fb7105203ab5f75bbcaa53ded (diff) | |
| download | garage-7d3a95183658afea1aeb0cbd435bdec4ebfc71e8.tar.gz garage-7d3a95183658afea1aeb0cbd435bdec4ebfc71e8.zip | |
document rpc crate
Diffstat (limited to 'src/rpc/rpc_server.rs')
| -rw-r--r-- | src/rpc/rpc_server.rs | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/rpc/rpc_server.rs b/src/rpc/rpc_server.rs index 0d82d796..4419a6f0 100644 --- a/src/rpc/rpc_server.rs +++ b/src/rpc/rpc_server.rs @@ -1,3 +1,4 @@ +//! Contains structs related to receiving RPCs use std::collections::HashMap; use std::net::SocketAddr; use std::pin::Pin; @@ -22,13 +23,17 @@ use garage_util::error::Error; use crate::tls_util; +/// Trait for messages that can be sent as RPC pub trait RpcMessage: Serialize + for<'de> Deserialize<'de> + Send + Sync {} type ResponseFuture = Pin<Box<dyn Future<Output = Result<Response<Body>, Error>> + Send>>; type Handler = Box<dyn Fn(Request<Body>, SocketAddr) -> ResponseFuture + Send + Sync>; +/// Structure handling RPCs pub struct RpcServer { + /// The address the RpcServer will bind pub bind_addr: SocketAddr, + /// The tls configuration used for RPC pub tls_config: Option<TlsConfig>, handlers: HashMap<String, Handler>, @@ -87,6 +92,7 @@ where } impl RpcServer { + /// Create a new RpcServer pub fn new(bind_addr: SocketAddr, tls_config: Option<TlsConfig>) -> Self { Self { bind_addr, @@ -95,6 +101,7 @@ impl RpcServer { } } + /// Add handler handling request made to `name` pub fn add_handler<M, F, Fut>(&mut self, name: String, handler: F) where M: RpcMessage + 'static, @@ -156,6 +163,7 @@ impl RpcServer { } } + /// Run the RpcServer pub async fn run( self: Arc<Self>, shutdown_signal: impl Future<Output = ()>, |