Struct ClientSseTransport

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

Client-side Server-Sent Events (SSE) transport implementation

Manages SSE connections, HTTP POST requests, and message streaming for client-server communication.

Implementations

impl<R> ClientSseTransport<R>

where R: Clone + Send + Sync + DeserializeOwned + 'static,

pub fn new( server_url: &str, options: ClientSseTransportOptions, ) -> Result<ClientSseTransport<R>, TransportError>

Creates a new ClientSseTransport instance

Initializes the transport with the provided server URL and options.

Arguments

• server_url - The URL of the SSE server
• options - Configuration options for the transport

Returns

• TransportResult<Self> - The initialized transport or an error

pub fn validate_message_endpoint( &self, endpoint: String, ) -> Result<String, TransportError>

Validates the message endpoint URL

Ensures the endpoint is either relative to the base URL or matches the base URL’s origin.

Arguments

• endpoint - The endpoint URL to validate

Returns

• TransportResult<String> - The validated endpoint URL or an error

Trait Implementations

impl<R, S, M, OR, OM> Transport<R, S, M, OR, OM> for ClientSseTransport<M>

where R: Clone + Send + Sync + DeserializeOwned + 'static, S: McpMessage + Clone + Send + Sync + Serialize + 'static, M: Clone + Send + Sync + DeserializeOwned + 'static, OR: Clone + Send + Sync + Serialize + 'static, OM: Clone + Send + Sync + DeserializeOwned + 'static,

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

where 'life0: 'async_trait, MessageDispatcher<M>: McpDispatch<R, OR, M, OM>, ClientSseTransport<M>: 'async_trait,

Starts the transport, initializing SSE and POST tasks

Sets up the SSE stream, POST request handler, and message streams for communication.

Returns

• TransportResult<(Pin<Box<dyn Stream<Item = R> + Send>>, MessageDispatcher<R>, IoStream)>
  • The message stream, dispatcher, and error stream

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

where 'life0: 'async_trait, ClientSseTransport<M>: 'async_trait,

Checks if the transport has been shut down

Returns

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

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

where 'life0: 'async_trait, ClientSseTransport<M>: 'async_trait,

Sends a shutdown signal via the watch channel and kills the subprocess if present.

Returns

A TransportResult indicating success or failure.

Errors

Returns a TransportError if the shutdown signal fails or the process cannot be killed.

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

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

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, ClientSseTransport<M>: 'async_trait,

fn keep_alive<'life0, 'async_trait>( &'life0 self, __arg1: Duration, __arg2: Sender<()>, ) -> Pin<Box<dyn Future<Output = Result<JoinHandle<()>, TransportError>> + Send + 'async_trait>>

where 'life0: 'async_trait, ClientSseTransport<M>: 'async_trait,

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

where 'life0: 'async_trait, 'life1: 'async_trait, ClientSseTransport<M>: 'async_trait,