Skip to main content

RunningService

Struct RunningService 

Source
pub struct RunningService<R, S>
where R: ServiceRole, S: Service<R>,
{ /* private fields */ }

Implementations§

Source§

impl<S> RunningService<RoleClient, S>
where S: Service<RoleClient>,

Source

pub async fn call_tool_once( &self, params: CallToolRequestParams, ) -> Result<CallToolResponse, ServiceError>

Send one tools/call request without driving MRTR follow-up rounds.

Source

pub async fn get_prompt_once( &self, params: GetPromptRequestParams, ) -> Result<GetPromptResponse, ServiceError>

Send one prompts/get request without driving MRTR follow-up rounds.

Source

pub async fn read_resource_once( &self, params: ReadResourceRequestParams, ) -> Result<ReadResourceResponse, ServiceError>

Send one resources/read request without driving MRTR follow-up rounds.

Source

pub async fn call_tool( &self, params: CallToolRequestParams, ) -> Result<CallToolResult, ServiceError>

High-level tools/call helper that automatically fulfils SEP-2322 input_required rounds through the local ClientHandler service.

§Errors

Returns ServiceError::InputRequiredRoundsExceeded if the peer does not produce a final CallToolResult within the default MRTR round cap. Other transport, protocol, and local input-handler errors are propagated.

Source

pub async fn call_tool_with_mrtr_max_rounds( &self, params: CallToolRequestParams, max_rounds: usize, ) -> Result<CallToolResult, ServiceError>

Same as Self::call_tool, with an explicit MRTR round cap.

§Errors

Returns ServiceError::InputRequiredRoundsExceeded once max_rounds input_required responses have been driven without receiving a final CallToolResult. Other transport, protocol, and local input-handler errors are propagated.

Source

pub async fn get_prompt( &self, params: GetPromptRequestParams, ) -> Result<GetPromptResult, ServiceError>

High-level prompts/get helper that automatically fulfils SEP-2322 input_required rounds through the local ClientHandler service.

§Errors

Returns ServiceError::InputRequiredRoundsExceeded if the peer does not produce a final GetPromptResult within the default MRTR round cap. Other transport, protocol, and local input-handler errors are propagated.

Source

pub async fn get_prompt_with_mrtr_max_rounds( &self, params: GetPromptRequestParams, max_rounds: usize, ) -> Result<GetPromptResult, ServiceError>

Same as Self::get_prompt, with an explicit MRTR round cap.

§Errors

Returns ServiceError::InputRequiredRoundsExceeded once max_rounds input_required responses have been driven without receiving a final GetPromptResult. Other transport, protocol, and local input-handler errors are propagated.

Source

pub async fn read_resource( &self, params: ReadResourceRequestParams, ) -> Result<ReadResourceResult, ServiceError>

High-level resources/read helper that automatically fulfils SEP-2322 input_required rounds through the local ClientHandler service.

§Errors

Returns ServiceError::InputRequiredRoundsExceeded if the peer does not produce a final ReadResourceResult within the default MRTR round cap. Other transport, protocol, and local input-handler errors are propagated.

Source

pub async fn read_resource_with_mrtr_max_rounds( &self, params: ReadResourceRequestParams, max_rounds: usize, ) -> Result<ReadResourceResult, ServiceError>

Same as Self::read_resource, with an explicit MRTR round cap.

§Errors

Returns ServiceError::InputRequiredRoundsExceeded once max_rounds input_required responses have been driven without receiving a final ReadResourceResult. Other transport, protocol, and local input-handler errors are propagated.

Source§

impl<R, S> RunningService<R, S>
where R: ServiceRole, S: Service<R>,

Source

pub fn peer(&self) -> &Peer<R>

Source

pub fn service(&self) -> &S

Source

pub fn cancellation_token(&self) -> RunningServiceCancellationToken

Source

pub fn is_closed(&self) -> bool

Returns true if the service has been closed or cancelled.

Source

pub async fn waiting(self) -> Result<QuitReason, JoinError>

Wait for the service to complete.

This will block until the service loop terminates (either due to cancellation, transport closure, or an error).

Source

pub async fn close(&mut self) -> Result<QuitReason, JoinError>

Gracefully close the connection and wait for cleanup to complete.

This method cancels the service, waits for the background task to finish (which includes calling transport.close()), and ensures all cleanup operations complete before returning.

Unlike cancel, this method takes &mut self and can be called without consuming the RunningService. After calling this method, the service is considered closed and subsequent operations will fail.

§Example
ⓘ
let mut client = ().serve(transport).await?;
// ... use the client ...
client.close().await?;
Source

pub async fn close_with_timeout( &mut self, timeout: Duration, ) -> Result<Option<QuitReason>, JoinError>

Gracefully close the connection with a timeout.

Similar to close, but returns after the specified timeout if the cleanup doesn’t complete in time. This is useful for ensuring a bounded shutdown time.

Returns Ok(Some(reason)) if shutdown completed within the timeout, Ok(None) if the timeout was reached, or Err if there was a join error.

Source

pub async fn cancel(self) -> Result<QuitReason, JoinError>

Cancel the service and wait for cleanup to complete.

This consumes the RunningService and ensures the connection is properly closed. For a non-consuming alternative, see close.

Methods from Deref<Target = Peer<R>>§

Source

pub async fn send_notification( &self, notification: <R as ServiceRole>::Not, ) -> Result<(), ServiceError>

Source

pub async fn send_request( &self, request: <R as ServiceRole>::Req, ) -> Result<<R as ServiceRole>::PeerResp, ServiceError>

Source

pub async fn send_cancellable_request( &self, request: <R as ServiceRole>::Req, options: PeerRequestOptions, ) -> Result<RequestHandle<R>, ServiceError>

Source

pub async fn send_request_with_option( &self, request: <R as ServiceRole>::Req, options: PeerRequestOptions, ) -> Result<RequestHandle<R>, ServiceError>

Source

pub fn peer_info(&self) -> Option<Arc<<R as ServiceRole>::PeerInfo>>

Snapshot of the peer’s handshake info.

Source

pub fn set_peer_info(&self, info: <R as ServiceRole>::PeerInfo)

Stores the peer’s handshake info, overwriting any previous value.

Source

pub fn is_transport_closed(&self) -> bool

Trait Implementations§

Source§

impl<R, S> Debug for RunningService<R, S>
where R: Debug + ServiceRole, S: Debug + Service<R>,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<R, S> Deref for RunningService<R, S>
where R: ServiceRole, S: Service<R>,

Source§

type Target = Peer<R>

The resulting type after dereferencing.
Source§

fn deref(&self) -> &<RunningService<R, S> as Deref>::Target

Dereferences the value.
Source§

impl<R, S> Drop for RunningService<R, S>
where R: ServiceRole, S: Service<R>,

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

Auto Trait Implementations§

§

impl<R, S> !RefUnwindSafe for RunningService<R, S>

§

impl<R, S> !UnwindSafe for RunningService<R, S>

§

impl<R, S> Freeze for RunningService<R, S>

§

impl<R, S> Send for RunningService<R, S>

§

impl<R, S> Sync for RunningService<R, S>

§

impl<R, S> Unpin for RunningService<R, S>

§

impl<R, S> UnsafeUnpin for RunningService<R, S>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
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