Enum w5500_ll::SocketCommand

#[repr(u8)]
pub enum SocketCommand {
    Accepted,
    Open,
    Listen,
    Connect,
    Disconnect,
    Close,
    Send,
    SendMac,
    SendKeep,
    Recv,
}

Socket commands.

This is used to set the command for socket n.

After W5500 accepts the command, the sn_cr register is automatically cleared to 0x00. Even though sn_cr is cleared to 0x00, the command is still being processed. To check whether the command is completed or not, check sn_ir or sn_sr.

Variants

Accepted

The command register clears to this state once a command has been accepted.

Open

The socket is initialized and opened according to the protocol selected in sn_mr.

sn_mr	sn_sr
Protocol::Closed	-
Protocol::Tcp	SocketStatus::Init
Protocol::Udp	SocketStatus::Udp
Protocol::Macraw	SocketStatus::Macraw

Listen

Operate the socket as a TCP server.

This will change the socket state from Init to Listen, and the socket will listen for a connection-request (SYN packet) from any TCP client.

When a TCP client connection request is successfully established, the socket state changes from Listen to Established and the CON socket interrupt is raised.

When a TCP client connection request fails the TIMEOUT socket interrupt is set and the socket status changes to Closed.

Only valid in Tcp mode.

Connect

Connect to a TCP server.

A connect-request (SYN packet) is sent to the TCP server configured by the IPv4 address and port set with set_sn_dest.

If the connect-request is successful, the socket state changes to Established and the CON socket interrupt is raised.

The connect-request fails in the following three cases:

1. When a ARP_TO occurs (timeout_raised) because the destination hardware address is not acquired through the ARP-process.
2. When a SYN/ACK packet is not received within the TCP timeout duration set by rcr and rtr (timeout_raised).
3. When a RST packet is received instead of a SYN/ACK packet.

In these cases the socket state changes to Closed.

Only valid in Tcp mode when acting as a TCP client.

Disconnect

Start the disconnect process.

• Active close it transmits disconnect-request(FIN packet) to the connected peer.
• Passive close when FIN packet is received from peer, a FIN packet is replied back to the peer.

When the disconnect-process is successful (that is, FIN/ACK packet is received successfully), the socket state changes to Closed. Otherwise, TCP timeout occurs (timeout_raised) and then the socket state changes to Closed.

If the Close command is used instead of Disconnect, the socket state is changes to Closed without the disconnect process.

If a RST packet is received from a peer during communication the socket status is unconditionally changed to Closed.

Only valid in Tcp mode.

Close

Close the socket.

The socket status is changed to Closed.

Send

Transmits all the data in the socket TX buffer.

SendMac

The basic operation is same as Send.

Normally Send transmits data after destination hardware address is acquired by the automatic ARP-process (Address Resolution Protocol). SendMac transmits data without the automatic ARP-process. In this case, the destination hardware address is acquired from sn_dhar configured by the host, instead of the ARP process.

Only valid in Udp mode.

SendKeep

Sends a 1 byte keep-alive packet.

If the peer cannot respond to the keep-alive packet during timeout time, the connection is terminated and the timeout interrupt will occur (timeout_raised).

Only valid in Tcp mode.

Recv

Completes the processing of the received data in socket RX buffer.

See sn_rx_buf for an example.

Trait Implementations

impl Clone for SocketCommand

fn clone(&self) -> SocketCommand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocketCommand

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

Formats the value using the given formatter.

impl Format for SocketCommand

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl From<SocketCommand> for u8

fn from(val: SocketCommand) -> u8

Performs the conversion.

impl Hash for SocketCommand

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

Feeds this value into the given Hasher.

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 SocketCommand

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<SocketCommand> for SocketCommand

fn eq(&self, other: &SocketCommand) -> 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 !=.

impl PartialOrd<SocketCommand> for SocketCommand

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

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

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

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

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

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

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

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

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 TryFrom<u8> for SocketCommand

type Error = u8

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for SocketCommand

impl Eq for SocketCommand

impl StructuralEq for SocketCommand

impl StructuralPartialEq for SocketCommand