Struct SocketInterrupt

pub struct SocketInterrupt(/* private fields */);

Socket Interrupt Register (Sn_IR).

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

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

Implementations

impl SocketInterrupt

pub const RESET: u8 = 0u8

Socket interrupt status register (Sn_IR) reset value.

pub const DEFAULT: Self

Default value.

This is the same as default, but as a const value.

Example

use w5500_ll::SocketInterrupt;

assert_eq!(SocketInterrupt::DEFAULT, SocketInterrupt::default());

pub const CON_OFFSET: u8 = 0u8

Bit offset for the CON field.

pub const DISCON_OFFSET: u8 = 1u8

Bit offset for the DISCON field.

pub const RECV_OFFSET: u8 = 2u8

Bit offset for the RECV field.

pub const TIMEOUT_OFFSET: u8 = 3u8

Bit offset for the TIMEOUT field.

pub const SENDOK_OFFSET: u8 = 4u8

Bit offset for the SENDOK field.

pub const CON_MASK: u8 = 1u8

Bit mask for the CON field.

pub const DISCON_MASK: u8 = 2u8

Bit mask for the DISCON field.

pub const RECV_MASK: u8 = 4u8

Bit mask for the RECV field.

pub const TIMEOUT_MASK: u8 = 8u8

Bit mask for the TIMEOUT field.

pub const SENDOK_MASK: u8 = 16u8

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

use w5500_ll::SocketInterrupt;

let sir: SocketInterrupt = SocketInterrupt::DEFAULT;
assert!(!sir.con_raised());

pub const fn clear_con(self) -> 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

use w5500_ll::SocketInterrupt;

let sir: SocketInterrupt = SocketInterrupt::DEFAULT;
assert!(!sir.discon_raised());

pub const fn clear_discon(self) -> 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

use w5500_ll::SocketInterrupt;

let sir: SocketInterrupt = SocketInterrupt::DEFAULT;
assert!(!sir.recv_raised());

pub const fn clear_recv(self) -> 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

use w5500_ll::SocketInterrupt;

let sir: SocketInterrupt = SocketInterrupt::DEFAULT;
assert!(!sir.timeout_raised());

pub const fn clear_timeout(self) -> Self

Clear the TIMEOUT interrupt by writing 1.

pub const fn sendok_raised(&self) -> bool

Get the value of the SENDOK interrupt.

This is issued when SEND command is completed.

Example

use w5500_ll::SocketInterrupt;

let sir: SocketInterrupt = SocketInterrupt::DEFAULT;
assert!(!sir.sendok_raised());

pub const fn clear_sendok(self) -> Self

Clear the SENDOK interrupt by writing 1.

pub const fn any_raised(&self) -> bool

Returns true if any interrupt is raised.

Example

use w5500_ll::SocketInterrupt;

assert!(!SocketInterrupt::DEFAULT.any_raised());

Trait Implementations

impl Clone for SocketInterrupt

fn clone(&self) -> SocketInterrupt

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketInterrupt

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

Formats the value using the given formatter.

impl Default for SocketInterrupt

fn default() -> Self

Returns the “default value” for a type.

impl Display for SocketInterrupt

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

Formats the value using the given formatter.

impl Format for SocketInterrupt

Available on crate feature defmt only.

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

Writes the defmt representation of self to fmt.

impl From<SocketInterrupt> for u8

fn from(val: SocketInterrupt) -> u8

Converts to this type from the input type.

impl From<u8> for SocketInterrupt

fn from(val: u8) -> Self

Converts to this type from the input type.

impl PartialEq for SocketInterrupt

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for SocketInterrupt

impl Eq for SocketInterrupt

impl StructuralPartialEq for SocketInterrupt