Enum w5500_ll::SocketStatus

#[repr(u8)]pub enum SocketStatus {
    Closed,
    Init,
    Listen,
    SynSent,
    SynRecv,
    Established,
    FinWait,
    Closing,
    TimeWait,
    CloseWait,
    LastAck,
    Udp,
    Macraw,
}

Socket status.

This is used with crate::Registers::sn_sr.

Variants

Closed

Socket closed, this is the reset state of all sockets.

This state can be set by a SocketCommand::Disconnect or SocketCommand::Close command.

This state will also be set automatically if a timeout occurs.

Init

The socket is opened in TCP mode.

This state is set when the socket protocol is Protocol::Tcp, and a SocketCommand::Open command is sent.

In this state you can use the SocketCommand::Listen and SocketCommand::Connect commands.

Listen

The socket is listening, operating as a TCP server.

The socket will wait for a connextion-request (SYN packet) from a peer (TCP client).

The state will change to SocketStatus::Established when the connection-request is successfully accepted. Otherwise the state will change to SocketStatus::Closed after the TCP timeout duration set by crate::Registers::rcr and crate::Registers::rtr.

SynSent

Connection request (SYN packet) has been sent to a peer.

This is temporarily displayed between the SocketStatus::Init and SocketStatus::Established states, after a SocketCommand::Connect command has been sent.

If the SYN/ACK is received from the peer the state changes to SocketStatus::Established, otherwise the state changes to SocketStatus::Closed after the TCP timeout duration set by crate::Registers::rcr and crate::Registers::rtr.

SynRecv

Connection request (SYN packet) has been received from a peer.

If the socket sends the response (SYN/ACK packet) to the peer successfully the state changes to SocketStatus::Established, otherwise the state changes to SocketStatus::Closed after the TCP timeout duration set by crate::Registers::rcr and crate::Registers::rtr.

Established

TCP connection is established.

When operating as a TCP client this state is set after the TCP server accepts the SYN packet, which is sent by the client after issuing a SocketCommand::Connect.

When operating as a TCP server this state is set after a client connects when in the SocketStatus::Listen state.

While in this state data can be transfered with the SocketCommand::Send and SocketCommand::Recv commands.

FinWait

Temporary status between status transitions.

This indicates the socket is closing.

Closing

Temporary status between status transitions.

This indicates the socket is closing.

TimeWait

Temporary status between status transitions.

This indicates the socket is closing.

CloseWait

The socket has received the disconnect-request (FIN pakcet) from the connected peer.

This is half-closing status, and data can be transferred.

For full-closing the SocketCommand::Disconnect command is used.

For just-closing the SocketCommand::Close command is used.

LastAck

Temporary status between status transitions.

Udp

Socket is opened in UDP mode.

This state is set when the socket protocol is Protocol::Udp, and a SocketCommand::Open command is sent.

Macraw

Socket is opened in MACRAW mode.

This is valid only for socket 0.

This state is set when the socket protocol is Protocol::Macraw, and a SocketCommand::Open command is sent.

Trait Implementations

impl Clone for SocketStatus

pub fn clone(&self) -> SocketStatus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SocketStatus

impl Debug for SocketStatus

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

Formats the value using the given formatter.

impl Default for SocketStatus

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for SocketStatus

impl Hash for SocketStatus

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for SocketStatus

pub fn cmp(&self, other: &SocketStatus) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<SocketStatus> for SocketStatus

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<SocketStatus> for SocketStatus

pub fn partial_cmp(&self, other: &SocketStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for SocketStatus

impl StructuralPartialEq for SocketStatus

impl TryFrom<u8> for SocketStatus

type Error = u8

The type returned in the event of a conversion error.

pub fn try_from(val: u8) -> Result<SocketStatus, u8>

Performs the conversion.