Struct engineioxide::socket::Socket

pub struct Socket<H>where
    H: EngineIoHandler + ?Sized,{
    pub sid: Sid,
    pub protocol: ProtocolVersion,
    pub tx: Sender<SendPacket>,
    pub data: H::Data,
    pub req_data: Arc<SocketReq>,
    /* private fields */
}

A Socket represents a connection to the server. It is agnostic to the TransportType. It handles :

• the packet communication between with the Engine and the user defined Handler.
• the user defined Data bound to the socket.
• the heartbeat job that verify that the connection is still up by sending packets periodically.

Fields

sid: Sid

The socket id

protocol: ProtocolVersion

The protocol version used by the socket

tx: Sender<SendPacket>

data: H::Data

User data bound to the socket

req_data: Arc<SocketReq>

Http Request data used to create a socket

Implementations

impl<H> Socket<H>where H: EngineIoHandler + ?Sized,

pub fn emit(&self, msg: String) -> Result<(), Error>

Emits a message to the client.

If the transport is in websocket mode, the message is directly sent as a text frame.

If the transport is in polling mode, the message is buffered and sent as a text frame to the next polling request.

⚠️ If the buffer is full or the socket is disconnected, an error will be returned

pub fn close(&self)

Immediately closes the socket and the underlying connection. The socket will be removed from the Engine and the Handler will be notified.

pub fn emit_binary(&self, data: Vec<u8>) -> Result<(), Error>

Emits a binary message to the client.

If the transport is in websocket mode, the message is directly sent as a binary frame.

If the transport is in polling mode, the message is buffered and sent as a text frame encoded in base64 to the next polling request.

⚠️ If the buffer is full or the socket is disconnected, an error will be returned