Struct PjsWebSocketClient 

pub struct PjsWebSocketClient { /* private fields */ }

WebSocket client for receiving PJS streams

Implementations

impl PjsWebSocketClient

pub fn new(url: impl AsRef<str>) -> PjsResult<Self>

Create new WebSocket client

pub fn with_write_timeout(self, write_timeout: Duration) -> Self

Overrides the deadline for a single outbound WebSocket sink write, used by the send_task spawned in Self::connect.

Defaults to infrastructure::websocket::WRITE_TIMEOUT (10s) — see its doc for the rationale and the tradeoff it implies for large frames sent to slow clients. Pair a shorter value with a resource-constrained deployment where freeing a wedged send task quickly matters more than absorbing network jitter (mirroring RateLimitConfig::low_resource’s tightened write_timeout on the server side); pair a longer value with a deployment that expects large payloads over slow or high-latency uplinks and would otherwise see legitimate writes misclassified as stalled.

write_timeout is not validated: Duration::ZERO leaves at most one poll of the underlying write before it is treated as a timeout, and an arbitrarily large value (including Duration::MAX) is accepted as-is and does not panic, since tokio::time::timeout clamps internally.

Examples

use pjson_rs::infrastructure::websocket::PjsWebSocketClient;
use std::time::Duration;

let client = PjsWebSocketClient::new("ws://localhost:3001/ws")
    .unwrap()
    .with_write_timeout(Duration::from_secs(3));

pub async fn connect(&self) -> PjsResult<()>

Connect to WebSocket server and start message handling

pub async fn request_stream( &self, data: Value, options: Option<StreamOptions>, ) -> PjsResult<String>

Request stream initialization

pub async fn get_current_data( &self, session_id: &str, ) -> PjsResult<Option<Value>>

Get current reconstructed data for session

pub async fn is_stream_complete(&self, session_id: &str) -> bool

Check if stream is complete

pub async fn get_stream_stats(&self, session_id: &str) -> Option<StreamStats>

Get stream statistics