Skip to main content

WebSocketTransport

Struct WebSocketTransport 

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

WebSocket transport: JSON-RPC 2.0 over a persistent WebSocket connection.

Create via WebSocketTransport::connect and pass to crate::ClientBuilder::with_custom_transport.

FIX(C2): Uses a dedicated reader task with message routing instead of a shared Mutex on the reader half. This prevents deadlocks when streaming responses are received concurrently with unary requests.

Implementations§

Source§

impl WebSocketTransport

Source

pub async fn connect(endpoint: impl Into<String>) -> ClientResult<Self>

Connects to the agent’s WebSocket endpoint.

The endpoint should use the ws:// or wss:// scheme.

§Errors

Returns ClientError::Transport if the WebSocket handshake fails.

Source

pub async fn connect_with_timeout( endpoint: impl Into<String>, request_timeout: Duration, ) -> ClientResult<Self>

Connects with a custom request timeout.

§Errors

Returns ClientError::Transport if the WebSocket handshake fails.

Source

pub async fn connect_with_options( endpoint: impl Into<String>, request_timeout: Duration, extra_headers: &HashMap<String, String>, ) -> ClientResult<Self>

Connects with a custom request timeout and extra HTTP headers for the initial WebSocket upgrade request.

FIX(C3): Extra headers (e.g. from AuthInterceptor) are applied to the HTTP upgrade request that establishes the WebSocket connection via the tungstenite IntoClientRequest trait.

§Errors

Returns ClientError::Transport if the WebSocket handshake fails.

Source

pub fn endpoint(&self) -> &str

Returns the endpoint URL this transport is connected to.

Trait Implementations§

Source§

impl Debug for WebSocketTransport

Source§

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

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

impl Transport for WebSocketTransport

Source§

fn send_request<'a>( &'a self, method: &'a str, params: Value, extra_headers: &'a HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = ClientResult<Value>> + Send + 'a>>

Sends a non-streaming JSON-RPC or REST request. Read more
Source§

fn send_streaming_request<'a>( &'a self, method: &'a str, params: Value, extra_headers: &'a HashMap<String, String>, ) -> Pin<Box<dyn Future<Output = ClientResult<EventStream>> + Send + 'a>>

Sends a streaming request and returns an EventStream. 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<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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
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