Enum SocketState 

pub enum SocketState<I: IpExt, D: WeakDeviceIdentifier, S: DatagramSocketSpec> {
    Unbound(UnboundSocketState<I, D, S>),
    Bound(BoundSocketState<I, D, S>),
}

A datagram socket’s state.

Variants

Unbound(UnboundSocketState<I, D, S>)

Bound(BoundSocketState<I, D, S>)

Implementations

impl<I: IpExt, D: WeakDeviceIdentifier, S: DatagramSocketSpec> SocketState<I, D, S>

pub fn to_socket_info(&self) -> SocketInfo<I::Addr, D>

Returns SocketInfo for this datagram socket.

pub fn local_ip( &self, ) -> Option<StrictlyZonedAddr<I::Addr, SpecifiedAddr<I::Addr>, D>>

Returns the local IP address, if the socket is bound to one.

pub fn local_identifier(&self) -> Option<NonZeroU16>

Returns the local socket identifier (e.g. port), if the socket is bound to one.

pub fn remote_ip( &self, ) -> Option<StrictlyZonedAddr<I::Addr, SpecifiedAddr<I::Addr>, D>>

Returns the remote IP address, if the datagram socket is connected.

pub fn remote_identifier(&self) -> Option<u16>

Returns the remote identifier (e.g. port), if the datagram socket is connected.

pub fn record_common_info<N>(&self, inspector: &mut N)

where N: Inspector + InspectorDeviceExt<D>,

Record inspect information generic to each datagram protocol.

pub fn get_options_device<'a, BC: DatagramBindingsTypes, CC: DatagramBoundStateContext<I, BC, S, WeakDeviceId = D>>( &'a self, core_ctx: &CC, ) -> (&'a IpOptions<I, CC::WeakDeviceId, S>, &'a Option<CC::WeakDeviceId>)

Gets the IpOptions and bound device for the socket state.

pub fn get_options<'a, BC: DatagramBindingsTypes, CC: DatagramBoundStateContext<I, BC, S, WeakDeviceId = D>>( &'a self, core_ctx: &CC, ) -> &'a IpOptions<I, CC::WeakDeviceId, S>

Returns IpOptions.

pub fn get_options_mut<'a, BC: DatagramBindingsTypes, CC: DatagramBoundStateContext<I, BC, S, WeakDeviceId = D>>( &'a mut self, core_ctx: &mut CC, ) -> &'a mut IpOptions<I, CC::WeakDeviceId, S>

Returns mutable IpOptions.

Trait Implementations

impl<I: IpExt, D: WeakDeviceIdentifier, S: DatagramSocketSpec> AsRef<IpOptions<I, D, S>> for SocketState<I, D, S>

fn as_ref(&self) -> &IpOptions<I, D, S>

Converts this type into a shared reference of the (usually inferred) input type.

impl<I: IpExt, D: WeakDeviceIdentifier, S: DatagramSocketSpec> Debug for SocketState<I, D, S>

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

Formats the value using the given formatter.

impl<I: IpExt, D: WeakDeviceIdentifier, S: DatagramSocketSpec, IpType> GenericOverIp<IpType> for SocketState<I, D, S>

where IpType: IpExt + Ip,

type Type = SocketState<IpType, D, S>

The type of Self when its IP-generic parameter is replaced with the type NewIp.

impl<I: IpExt, D: WeakDeviceIdentifier, S: DatagramSocketSpec> OrderedLockAccess<SocketState<I, D, S>> for ReferenceState<I, D, S>

type Lock = RwLock<SocketState<I, D, S>>

The lock type that observes ordering.

fn ordered_lock_access(&self) -> OrderedLockRef<'_, Self::Lock>

Returns a borrow to the order-aware lock.