SseTransport

Struct SseTransport 

Source
pub struct SseTransport<R>
where R: Clone + Send + Sync + DeserializeOwned + 'static,
{ /* private fields */ }

Implementations§

Source§

impl<R> SseTransport<R>
where R: Clone + Send + Sync + DeserializeOwned + 'static,

Server-Sent Events (SSE) transport implementation

Source

pub fn new( read_rx: DuplexStream, write_tx: DuplexStream, receiver_tx: DuplexStream, options: Arc<TransportOptions>, ) -> Result<SseTransport<R>, TransportError>

Creates a new SseTransport instance

Initializes the transport with provided read and write duplex streams and options.

§Arguments
  • read_rx - Duplex stream for receiving messages
  • write_tx - Duplex stream for sending messages
  • receiver_tx - Duplex stream for receiving string payload
  • options - Shared transport configuration options
§Returns
  • TransportResult<Self> - The initialized transport or an error
Source

pub fn message_endpoint(endpoint: &str, session_id: &String) -> String

Trait Implementations§

Source§

impl McpDispatch<ClientMessages, ServerMessages, ClientMessage, ServerMessage> for SseTransport<ClientMessage>

Source§

fn send_message<'life0, 'async_trait>( &'life0 self, message: ServerMessages, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ClientMessages>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Sends a raw message represented by type S and optionally includes a request_id. The request_id is used when sending a message in response to an MCP request. It should match the request_id of the original request.
Source§

fn send<'life0, 'async_trait>( &'life0 self, message: ServerMessage, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<ClientMessage>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Source§

fn send_batch<'life0, 'async_trait>( &'life0 self, message: Vec<ServerMessage>, request_timeout: Option<Duration>, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<ClientMessage>>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Source§

fn write_str<'life0, 'life1, 'async_trait>( &'life0 self, payload: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Writes a string payload to the underlying asynchronous writable stream, appending a newline character and flushing the stream afterward.
Source§

impl Transport<ClientMessages, MessageFromServer, ClientMessage, ServerMessages, ServerMessage> for SseTransport<ClientMessage>

Source§

fn start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ReceiverStream<ClientMessages>, TransportError>> + Send + 'async_trait>>

Starts the transport, initializing streams and message dispatcher

Sets up the MCP stream and dispatcher using the provided duplex streams.

§Returns
  • TransportResult<(Pin<Box<dyn Stream<Item = R> + Send>>, MessageDispatcher<R>, IoStream)>
    • The message stream, dispatcher, and error stream
§Errors
  • Returns TransportError if streams are already taken or not initialized
Source§

fn is_shut_down<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Checks if the transport has been shut down

§Returns
  • bool - True if the transport is shut down, false otherwise
Source§

fn shut_down<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Shuts down the transport, terminating tasks and signaling closure

Cancels any running tasks and clears the cancellation source.

§Returns
  • TransportResult<()> - Ok if shutdown is successful, Err if cancellation fails
Source§

fn message_sender( &self, ) -> Arc<RwLock<Option<MessageDispatcher<ClientMessage>>>>

Source§

fn error_stream(&self) -> &RwLock<Option<IoStream>>

Source§

fn consume_string_payload<'life0, 'life1, 'async_trait>( &'life0 self, payload: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Source§

fn keep_alive<'life0, 'async_trait>( &'life0 self, interval: Duration, disconnect_tx: Sender<()>, ) -> Pin<Box<dyn Future<Output = Result<JoinHandle<()>, TransportError>> + Send + 'async_trait>>
where 'life0: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Source§

fn pending_request_tx<'life0, 'life1, 'async_trait>( &'life0 self, request_id: &'life1 RequestId, ) -> Pin<Box<dyn Future<Output = Option<Sender<ClientMessage>>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, SseTransport<ClientMessage>: 'async_trait,

Source§

impl TransportDispatcher<ClientMessages, MessageFromServer, ClientMessage, ServerMessages, ServerMessage> for SseTransport<ClientMessage>

Auto Trait Implementations§

§

impl<R> !Freeze for SseTransport<R>

§

impl<R> !RefUnwindSafe for SseTransport<R>

§

impl<R> Send for SseTransport<R>

§

impl<R> Sync for SseTransport<R>

§

impl<R> Unpin for SseTransport<R>

§

impl<R> !UnwindSafe for SseTransport<R>

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.

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

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