Struct WsConnection 

pub struct WsConnection {
    pub ws_sender: WsSender,
    pub ws_receiver: WsReceiver,
    pub msg_id: u64,
    pub connecting: bool,
    pub asking_size_max: u64,
    pub available: bool,
    pub name: String,
    pub auto_loading: bool,
    pub waiting_for_response: bool,
    pub headers_received: bool,
}

WsConnection struct

Fields

ws_sender: WsSender

WebSocket sender

ws_receiver: WsReceiver

WebSocket receiver

msg_id: u64

Message ID

connecting: bool

Connecting flag

asking_size_max: u64

Asking size max

available: bool

Available flag

name: String

Name of the receiver

auto_loading: bool

Auto-loading flag - when true, automatically requests more data

waiting_for_response: bool

Waiting for response flag - true when a request has been sent and we’re waiting for the response

headers_received: bool

Whether we have already requested and received headers (only need them once)

Implementations

impl WsConnection

pub fn new(ws_sender: WsSender, ws_receiver: WsReceiver) -> Self

Create a new WsConnection

pub fn connect( url: &str, wakeup: impl Fn() + Send + Sync + 'static, ) -> Result<(WsSender, WsReceiver), String>

Connect to a WebSocket

Errors

Return an error as String if the connection failed - see [ewebsock::connect_with_wakeup] for more details

pub fn close_impl(&mut self) -> Result<(), TramexError>

Try to close the ws

Errors

Return an error if its fail see [ewebsock::WsSender::close] for more details

impl WsConnection

pub fn should_request_more(&self) -> bool

Check if we should send a new request Returns true if auto-loading is enabled and not currently waiting for a response The server-side timeout and allow_empty=false handle the timing automatically

pub fn try_recv(&mut self, data: &mut Data) -> Result<(), Vec<TramexError>>

Try to receive data

Errors

Return an error if the data is not received correctly

Trait Implementations

impl Debug for WsConnection

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

Formats the value using the given formatter.

impl Drop for WsConnection

fn drop(&mut self)

Executes the destructor for this type.

impl InterfaceTrait for WsConnection

fn get_more_data( &mut self, layer_list: Layers, _data: &mut Data, ) -> Result<(), Vec<TramexError>>

Get more data

fn close(&mut self) -> Result<(), TramexError>

Try to close the interface

fn supports_preloading(&self) -> bool

Check if this interface supports preloading (e.g., file can preload, websocket cannot)

fn get_total_event_count(&self) -> Option<usize>

Get total event count if known (Some for files, None for websockets)

fn is_fully_read(&self) -> bool

Check if all data has been read