Struct rust_agent_sdk::Connection

pub struct Connection { /* fields omitted */ }

Send and receive Frame values from a remote peer.

When implementing networking protocols, a message on that protocol is often composed of several smaller messages known as frames. The purpose of Connection is to read and write frames on the underlying WsStream.

To read frames, the Connection uses an internal buffer, which is filled up until there are enough bytes to create a full frame. Once this happens, the Connection creates the frame and returns it to the caller.

When sending frames, the frame is first encoded into the write buffer. The contents of the write buffer are then written to the socket.

Implementations

impl Connection

pub fn new(socket: TcpStream) -> Connection

Create a new Connection, backed by socket. Read and write buffers are initialized.

Trait Implementations

impl Debug for Connection

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

Formats the value using the given formatter.