Skip to main content

LocalServiceBridge

Struct LocalServiceBridge 

Source
pub struct LocalServiceBridge { /* private fields */ }
Expand description

Adapt a crate::service::RequestService to IrohRequestProcessor.

Spins up a dedicated thread running a single-threaded tokio runtime with a LocalSet. The service runs on that thread (compatible with both Send and !Send services like inference); requests arriving on the iroh accept loop are forwarded via an mpsc channel and awaited via oneshot.

Lifecycle: shutdown closes admission, drains queued and running requests within the same grace period as network RPC, then destroys residual LocalSet tasks and joins the thread. A retained client cannot pin the service. Final handle drop provides synchronous cleanup; explicit owners use async shutdown.

Implementations§

Source§

impl LocalServiceBridge

Source

pub fn spawn<S>( service: S, nonce_cache: Arc<InMemoryNonceCache>, queue_depth: usize, ) -> Result<Self>
where S: RequestService + Send + 'static,

Spawn a dedicated bridge thread that owns service and forwards requests through crate::service::dispatch::process_request.

The response signing key is taken from service.signing_key() — there is no separate parameter to avoid drift between the service’s identity and the key used to sign responses.

queue_depth is the mpsc channel capacity — backpressure point when the bridge falls behind. Pass 0 for default (128).

Source

pub fn spawn_with<F, Fut, S>( thread_name: impl Into<String>, build: F, nonce_cache: Arc<InMemoryNonceCache>, queue_depth: usize, ) -> Result<(Self, Receiver<Result<()>>)>
where F: FnOnce() -> Fut + Send + 'static, Fut: Future<Output = Result<S>>, S: RequestService + 'static,

Like LocalServiceBridge::spawn, but constructs the service ON the bridge thread via the async build closure. For services whose construction is itself !Send or async (e.g. GPU init that must happen on the serve thread, like InferenceService): the built service value never has to be Send-moved across threads — only the builder’s captured inputs do (F: Send), and the !Send result lives only on the bridge thread.

Returns the bridge plus a readiness receiver that resolves once build completes: Ok(()) when the service is built and serving, or the build error. Callers MUST await it before advertising the service (a build failure otherwise surfaces only as “channel closed” on the first request).

Source§

impl LocalServiceBridge

Source

pub fn begin_shutdown(&self, deadline: Instant) -> Instant

Begin draining immediately; subsequent callers reuse the first deadline.

Source

pub async fn shutdown(&self) -> Result<(), BridgeShutdownError>

Close admission, drain accepted work, and wait for service/runtime destruction. Joining runs off the caller’s runtime; no thread lock is held while waiting. Concurrent close calls share the same terminal result.

Trait Implementations§

Source§

impl Drop for LocalServiceBridge

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl IrohRequestProcessor for LocalServiceBridge

Source§

fn close_admission(&self)

Close service admission before removing an in-process endpoint. The owning bridge performs the bounded drain and join separately.
Source§

fn begin_shutdown(&self, deadline: Instant) -> Instant

Close admission and establish one absolute request-drain deadline. A bridge returns its first deadline so later carrier/owner calls cannot restart the grace period. Joining remains the service owner’s duty.
Source§

fn process( &self, request: Bytes, carrier: CarrierContext, ) -> Pin<Box<dyn Future<Output = Result<Bytes>> + Send + '_>>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> MaybeSync for T
where T: Sync,