Enum socketioxide::socket::DisconnectReason

pub enum DisconnectReason {
    TransportClose,
    MultipleHttpPollingError,
    PacketParsingError,
    TransportError,
    HeartbeatTimeout,
    ClientNSDisconnect,
    ServerNSDisconnect,
    ClosingServer,
}

All the possible reasons for a Socket to be disconnected from a namespace.

It can be used as an extractor in the on_disconnect handler.

Variants

TransportClose

The client gracefully closed the connection

MultipleHttpPollingError

The client sent multiple polling requests at the same time (it is forbidden according to the engine.io protocol)

PacketParsingError

The client sent a bad request / the packet could not be parsed correctly

TransportError

The connection was closed (example: the user has lost connection, or the network was changed from WiFi to 4G)

HeartbeatTimeout

The client did not send a PONG packet in the ping timeout delay

ClientNSDisconnect

The client has manually disconnected the socket using socket.disconnect()

ServerNSDisconnect

The socket was forcefully disconnected from the namespace with Socket::disconnect

ClosingServer

The server is being closed

Trait Implementations

impl Clone for DisconnectReason

fn clone(&self) -> DisconnectReason

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DisconnectReason

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

Formats the value using the given formatter.

impl Display for DisconnectReason

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

Formats the value using the given formatter.

impl From<DisconnectReason> for DisconnectReason

fn from(reason: EIoDisconnectReason) -> Self

Converts to this type from the input type.

impl<A: Adapter> FromDisconnectParts<A> for DisconnectReason

type Error = Infallible

The error type returned by the extractor

fn from_disconnect_parts( _: &Arc<Socket<A>>, reason: DisconnectReason ) -> Result<Self, Infallible>

Extract the arguments from the disconnect event. If it fails, the handler is not called

impl PartialEq for DisconnectReason

fn eq(&self, other: &DisconnectReason) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DisconnectReason

impl Eq for DisconnectReason

impl StructuralPartialEq for DisconnectReason