Struct w5500_ll::SocketInterrupt

pub struct SocketInterrupt(_);

Socket Interrupt Register.

Indicated the socket status, such as connection, termination, receiving data, and timeout.

This is used by the crate::Registers::sn_ir and crate::Registers::set_sn_ir methods.

Implementations

impl SocketInterrupt

pub const RESET: u8

Socket interrupt status register (Sn_IR) reset value.

pub const CON_OFFSET: u8

Bit offset for the CON field.

pub const DISCON_OFFSET: u8

Bit offset for the DISCON field.

pub const RECV_OFFSET: u8

Bit offset for the RECV field.

pub const TIMEOUT_OFFSET: u8

Bit offset for the TIMEOUT field.

pub const SENDOK_OFFSET: u8

Bit offset for the SENDOK field.

pub const CON_MASK: u8

Bit mask for the CON field.

pub const DISCON_MASK: u8

Bit mask for the DISCON field.

pub const RECV_MASK: u8

Bit mask for the RECV field.

pub const TIMEOUT_MASK: u8

Bit mask for the TIMEOUT field.

pub const SENDOK_MASK: u8

Bit mask for the SENDOK field.

pub const fn con_raised(&self) -> bool

Get the value of the CON interrupt.

This is issued once when the connection with the peer is successful.

Example

let mut sir = w5500_ll::SocketInterrupt::default();
assert!(!sir.con_raised());

pub fn clear_con(&mut self)

Clear the CON interrupt by writing 1.

pub const fn discon_raised(&self) -> bool

Get the value of the DISCON interrupt.

This is issued when FIN or FIN/ACK packet is received from a peer.

Example

let mut sir = w5500_ll::SocketInterrupt::default();
assert!(!sir.discon_raised());

pub fn clear_discon(&mut self)

Clear the DISCON interrupt by writing 1.

pub const fn recv_raised(&self) -> bool

Get the value of the RECV interrupt.

This is issued whenever data is received from a peer.

Example

let mut sir = w5500_ll::SocketInterrupt::default();
assert!(!sir.recv_raised());

pub fn clear_recv(&mut self)

Clear the RECV interrupt by writing 1.

pub const fn timeout_raised(&self) -> bool

Get the value of the TIMEOUT interrupt.

This is issued when ARP_TO or TCP_TO occurs.

Example

let mut sir = w5500_ll::SocketInterrupt::default();
assert!(!sir.timeout_raised());

pub fn clear_timeout(&mut self)

Clear the TIMEOUT interrupt by writing 1.

pub fn sendok_raised(&self) -> bool

Get the value of the SENDOK interrupt.

This is issued when SEND command is completed.

Example

let mut sir = w5500_ll::SocketInterrupt::default();
assert!(!sir.sendok_raised());

pub fn clear_sendok(&mut self)

Clear the SENDOK interrupt by writing 1.

Trait Implementations

impl Clone for SocketInterrupt

pub fn clone(&self) -> SocketInterrupt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SocketInterrupt

impl Debug for SocketInterrupt

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

Formats the value using the given formatter.

impl Default for SocketInterrupt

pub fn default() -> Self

Returns the "default value" for a type.

impl Eq for SocketInterrupt

impl From<u8> for SocketInterrupt

pub fn from(val: u8) -> SocketInterrupt

Performs the conversion.

impl PartialEq<SocketInterrupt> for SocketInterrupt

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

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

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

This method tests for !=.

impl StructuralEq for SocketInterrupt

impl StructuralPartialEq for SocketInterrupt