mirror of
https://github.com/OMGeeky/tarpc.git
synced 2025-12-27 22:59:51 +01:00
905e5be8bb
# New Crates - crate rpc contains the core client/server request-response framework, as well as a transport trait. - crate bincode-transport implements a transport that works almost exactly as tarpc works today (not to say it's wire-compatible). - crate trace has some foundational types for tracing. This isn't really fleshed out yet, but it's useful for in-process log tracing, at least. All crates are now at the top level. e.g. tarpc-plugins is now tarpc/plugins rather than tarpc/src/plugins. tarpc itself is now a *very* small code surface, as most functionality has been moved into the other more granular crates. # New Features - deadlines: all requests specify a deadline, and a server will stop processing a response when past its deadline. - client cancellation propagation: when a client drops a request, the client sends a message to the server informing it to cancel its response. This means cancellations can propagate across multiple server hops. - trace context stuff as mentioned above - more server configuration for total connection limits, per-connection request limits, etc. # Removals - no more shutdown handle. I left it out for now because of time and not being sure what the right solution is. - all async now, no blocking stub or server interface. This helps with maintainability, and async/await makes async code much more usable. The service trait is thusly renamed Service, and the client is renamed Client. - no built-in transport. Tarpc is now transport agnostic (see bincode-transport for transitioning existing uses). - going along with the previous bullet, no preferred transport means no TLS support at this time. We could make a tls transport or make bincode-transport compatible with TLS. - a lot of examples were removed because I couldn't keep up with maintaining all of them. Hopefully the ones I kept are still illustrative. - no more plugins! # Open Questions 1. Should client.send() return `Future<Response>` or `Future<Future<Response>>`? The former appears more ergonomic but it doesn’t allow concurrent requests with a single client handle. The latter is less ergonomic but yields back control of the client once it’s successfully sent out the request. Should we offer fns for both? 2. Should rpc service! Fns take &mut self or &self or self? The service needs to impl Clone anyway, technically we only need to clone it once per connection, and then leave it up to the user to decide if they want to clone it per RPC. In practice, everyone doing nontrivial stuff will need to clone it per RPC, I think. 3. Do the request/response structs look ok? 4. Is supporting server shutdown/lameduck important? Fixes #178 #155 #124 #104 #83 #38
45 lines
1.9 KiB
Rust
45 lines
1.9 KiB
Rust
// Copyright 2018 Google Inc. All Rights Reserved.
|
|
//
|
|
// Licensed under the MIT License, <LICENSE or http://opensource.org/licenses/MIT>.
|
|
// This file may not be copied, modified, or distributed except according to those terms.
|
|
|
|
//! Provides a request context that carries a deadline and trace context. This context is sent from
|
|
//! client to server and is used by the server to enforce response deadlines.
|
|
|
|
use std::time::{Duration, SystemTime};
|
|
use trace::{self, TraceId};
|
|
|
|
/// A request context that carries request-scoped information like deadlines and trace information.
|
|
/// It is sent from client to server and is used by the server to enforce response deadlines.
|
|
///
|
|
/// The context should not be stored directly in a server implementation, because the context will
|
|
/// be different for each request in scope.
|
|
#[derive(Clone, Copy, Debug)]
|
|
#[non_exhaustive]
|
|
pub struct Context {
|
|
/// When the client expects the request to be complete by. The server should cancel the request
|
|
/// if it is not complete by this time.
|
|
pub deadline: SystemTime,
|
|
/// Uniquely identifies requests originating from the same source.
|
|
/// When a service handles a request by making requests itself, those requests should
|
|
/// include the same `trace_id` as that included on the original request. This way,
|
|
/// users can trace related actions across a distributed system.
|
|
pub trace_context: trace::Context,
|
|
}
|
|
|
|
/// Returns the context for the current request, or a default Context if no request is active.
|
|
// TODO: populate Context with request-scoped data, with default fallbacks.
|
|
pub fn current() -> Context {
|
|
Context {
|
|
deadline: SystemTime::now() + Duration::from_secs(10),
|
|
trace_context: trace::Context::new_root(),
|
|
}
|
|
}
|
|
|
|
impl Context {
|
|
/// Returns the ID of the request-scoped trace.
|
|
pub fn trace_id(&self) -> &TraceId {
|
|
&self.trace_context.trace_id
|
|
}
|
|
}
|