Struct re_sdk_comms::buffered_client::Client

pub struct Client {
    msg_tx: Sender<MsgMsg>,
    flushed_rx: Receiver<FlushedMsg>,
    encode_quit_tx: Sender<QuitMsg>,
    send_quit_tx: Sender<InterruptMsg>,
    encode_join: Option<JoinHandle<()>>,
    send_join: Option<JoinHandle<()>>,
    addr: SocketAddr,
}

Send [LogMsg]es to a server over TCP.

The messages are encoded and sent on separate threads so that calling Client::send is non-blocking.

Fields

msg_tx: Sender<MsgMsg>

flushed_rx: Receiver<FlushedMsg>

encode_quit_tx: Sender<QuitMsg>

send_quit_tx: Sender<InterruptMsg>

encode_join: Option<JoinHandle<()>>

send_join: Option<JoinHandle<()>>

addr: SocketAddr

Only used for diagnostics, not for communication after new().

Implementations

impl Client

pub fn new(addr: SocketAddr, flush_timeout: Option<Duration>) -> Self

Connect via TCP to this log server.

flush_timeout is the minimum time the TcpClient will wait during a flush before potentially dropping data. Note: Passing None here can cause a call to flush to block indefinitely if a connection cannot be established.

pub fn send(&self, log_msg: LogMsg)

pub fn flush(&self)

Stall until all messages so far has been sent.

pub fn drop_if_disconnected(&self)

Switch to a mode where we drop messages if disconnected.

Calling this before a flush (or drop) ensures we won’t get stuck trying to send messages to a closed endpoint, but we will still send all messages to an open endpoint.

fn send_msg_msg(&self, msg: MsgMsg)

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.

impl Drop for Client

fn drop(&mut self)

Wait until everything has been sent.