Skip to main content

ServerHandle

Struct ServerHandle 

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

A clone-able handle that changes a server while it serves.

What a Server hands out from Server::handle. It is cheap to clone and Send + Sync, so it can be stored in a server’s own state and reached from inside a tool: a tool that installs another tool is the shape a plugin loader takes.

Every change publishes the registry and then tells each session whose negotiated profile includes the matching listChanged capability. A session that never negotiated it hears nothing, so a change is never a message the peer has no contract for.

§Examples

use std::sync::Arc;

use protocol_droid::application::server::Server;
use protocol_droid::domain::ir::JsonObject;
use protocol_droid::domain::registry::Tool;

let server = Server::builder("plugins").build();
let handle = server.handle();

let fanout = handle
    .add_tool(
        Tool::new("late", r#"{"type":"object"}"#)?,
        Arc::new(|_ctx, _args| Box::pin(async { JsonObject::default() })),
    )
    .await;
assert!(fanout.is_silent(), "nobody is connected yet");
assert_eq!(server.tool_count(), 1);

Implementations§

Source§

impl ServerHandle

Source

pub async fn add_tool(&self, tool: Tool, handler: ToolHandler) -> Fanout

Adds or replaces a tool, and announces it.

Source

pub async fn add_restricted_tool( &self, registered: Registered, handler: ToolHandler, ) -> Fanout

Adds or replaces a tool carrying its own visibility requirements.

A Registered that is not a tool is listed and given no handler, which is the builder’s rule for the same input.

Source

pub async fn remove_tool(&self, name: &str) -> Fanout

Removes a tool, and announces it if there was one.

Source

pub async fn add_resource( &self, resource: Resource, reader: ResourceHandler, ) -> Fanout

Adds or replaces a resource with its reader, and announces it.

Source

pub async fn remove_resource(&self, uri: &str) -> Fanout

Removes a resource, and announces it if there was one.

Source

pub async fn add_resource_template(&self, template: ResourceTemplate) -> Fanout

Adds or replaces a resource template, and announces it.

Source

pub async fn remove_resource_template(&self, uri_template: &str) -> Fanout

Removes a resource template by its URI template, and announces it.

Source

pub async fn add_prompt(&self, prompt: Prompt, getter: PromptHandler) -> Fanout

Adds or replaces a prompt with its getter, and announces it.

Source

pub async fn remove_prompt(&self, name: &str) -> Fanout

Removes a prompt, and announces it if there was one.

Source

pub fn subscribe( &self, sink: &Arc<dyn DynFrameSink>, profile: FeatureProfile, kinds: &[ListKind], meta: Option<&Value>, ) -> ListSubscription

Subscribes sink to the list notifications in kinds.

For a transport, once per session: the session’s negotiated profile gates each notification, and meta — when present — is carried as the notification’s params._meta. The subscription lasts until the returned guard is dropped.

Source

pub async fn notify_resource_updated(&self, uri: &str) -> Fanout

Tells every session subscribed to uri that the resource changed.

notifications/resources/updated, sent to each session that asked for uri — through resources/subscribe before 2026-07-28, or through resourceSubscriptions on a listen stream from it on. A resource nobody subscribed to tells nobody.

Source

pub fn watch_resource( &self, sink: &Arc<dyn DynFrameSink>, uri: &str, meta: Option<&Value>, )

Adds uri to what sink’s session is told about.

The watch ends with the session’s ListSubscription, or with Self::unwatch_resource.

Source

pub fn unwatch_resource(&self, sink: &Arc<dyn DynFrameSink>, uri: &str)

Stops telling sink’s session about uri.

Source

pub fn watcher_count(&self) -> usize

How many sessions watch at least one resource.

Source

pub fn is_listed(&self, kind: PrimitiveKind, id: &str) -> bool

Whether a primitive of kind is listed under id right now.

A read of the live snapshot, so it can be stale the moment it returns if another handle is changing the server concurrently — fine for a toggle, wrong for anything that needs the answer to still hold.

Source

pub fn subscriber_count(&self) -> usize

How many sessions are currently subscribed, counting one per kind.

Trait Implementations§

Source§

impl Clone for ServerHandle

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ServerHandle

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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