netstack3_icmp_echo

Struct IcmpEchoSocketApi

Source 
pub struct IcmpEchoSocketApi<I: Ip, C>(/* private fields */);
Expand description

The ICMP Echo sockets API.

Implementations§

Source§

impl<I: Ip, C> IcmpEchoSocketApi<I, C>

Source

pub fn new(ctx: C) -> Self

Creates a new API instance.

Source§

impl<I, C> IcmpEchoSocketApi<I, C>
where I: IpExt, C: ContextPair, C::CoreContext: IcmpEchoStateContext<I, C::BindingsContext> + DatagramStateContext<I, C::BindingsContext, Icmp<C::BindingsContext>>, C::BindingsContext: IcmpEchoBindingsContext<I, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>,

Source

pub fn create( &mut self, ) -> IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>
where <C::BindingsContext as IcmpEchoBindingsTypes>::ExternalData<I>: Default,

Creates a new unbound ICMP socket with default external data.

Source

pub fn create_with( &mut self, external_data: <C::BindingsContext as IcmpEchoBindingsTypes>::ExternalData<I>, ) -> IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>

Creates a new unbound ICMP socket with provided external data.

Source

pub fn connect( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, remote_ip: Option<ZonedAddr<SpecifiedAddr<I::Addr>, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>>, remote_id: u16, ) -> Result<(), ConnectError>

Connects an ICMP socket to remote IP.

If the socket is never bound, an local ID will be allocated.

Source

pub fn bind( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, local_ip: Option<ZonedAddr<SpecifiedAddr<I::Addr>, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>>, icmp_id: Option<NonZeroU16>, ) -> Result<(), Either<ExpectedUnboundError, LocalAddressError>>

Binds an ICMP socket to a local IP address and a local ID.

Both the IP and the ID are optional. When IP is missing, the “any” IP is assumed; When the ID is missing, it will be allocated.

Source

pub fn get_info( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, ) -> SocketInfo<I::Addr, <C::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId>

Gets the information about an ICMP socket.

Source

pub fn set_device( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, device_id: Option<&<C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>, ) -> Result<(), SocketError>

Sets the bound device for a socket.

Sets the device to be used for sending and receiving packets for a socket. If the socket is not currently bound to a local address and port, the device will be used when binding.

Source

pub fn get_bound_device( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, ) -> Option<<C::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId>

Gets the device the specified socket is bound to.

Source

pub fn disconnect( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, ) -> Result<(), ExpectedConnError>

Disconnects an ICMP socket.

Source

pub fn shutdown( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, shutdown_type: ShutdownType, ) -> Result<(), ExpectedConnError>

Shuts down an ICMP socket.

Source

pub fn get_shutdown( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, ) -> Option<ShutdownType>

Gets the current shutdown state of an ICMP socket.

Source

pub fn close( &mut self, id: IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, ) -> RemoveResourceResultWithContext<<C::BindingsContext as IcmpEchoBindingsTypes>::ExternalData<I>, C::BindingsContext>

Closes an ICMP socket.

Source

pub fn get_unicast_hop_limit( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, ) -> NonZeroU8

Gets unicast IP hop limit for ICMP sockets.

Source

pub fn get_multicast_hop_limit( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, ) -> NonZeroU8

Gets multicast IP hop limit for ICMP sockets.

Source

pub fn set_unicast_hop_limit( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, hop_limit: Option<NonZeroU8>, )

Sets unicast IP hop limit for ICMP sockets.

Source

pub fn set_multicast_hop_limit( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, hop_limit: Option<NonZeroU8>, )

Sets multicast IP hop limit for ICMP sockets.

Source

pub fn get_multicast_loop( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, ) -> bool

Gets the loopback multicast option.

Source

pub fn set_multicast_loop( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, value: bool, )

Sets the loopback multicast option.

Source

pub fn set_mark( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, domain: MarkDomain, mark: Mark, )

Sets the socket mark for the socket domain.

Source

pub fn get_mark( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, domain: MarkDomain, ) -> Mark

Gets the socket mark for the socket domain.

Source

pub fn send<B: BufferMut>( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, body: B, ) -> Result<(), SendError<ParseError>>

Sends an ICMP packet through a connection.

The socket must be connected in order for the operation to succeed.

Source

pub fn send_to<B: BufferMut>( &mut self, id: &IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, remote_ip: Option<ZonedAddr<SpecifiedAddr<I::Addr>, <C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>>, body: B, ) -> Result<(), Either<LocalAddressError, SendToError<ParseError>>>

Sends an ICMP packet with an remote address.

The socket doesn’t need to be connected.

Source

pub fn collect_all_sockets( &mut self, ) -> Vec<IcmpSocketId<I, <<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>>

Collects all currently opened sockets, returning a cloned reference for each one.

Source

pub fn inspect<N>(&mut self, inspector: &mut N)
where N: Inspector + InspectorDeviceExt<<C::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId>,

Provides inspect data for ICMP echo sockets.

Auto Trait Implementations§

§

impl<I, C> Freeze for IcmpEchoSocketApi<I, C>
where C: Freeze,

§

impl<I, C> RefUnwindSafe for IcmpEchoSocketApi<I, C>
where C: RefUnwindSafe, I: RefUnwindSafe,

§

impl<I, C> Send for IcmpEchoSocketApi<I, C>
where C: Send,

§

impl<I, C> Sync for IcmpEchoSocketApi<I, C>
where C: Sync,

§

impl<I, C> Unpin for IcmpEchoSocketApi<I, C>
where C: Unpin, I: Unpin,

§

impl<I, C> UnwindSafe for IcmpEchoSocketApi<I, C>
where C: UnwindSafe, I: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<CC, BC, Meta> RecvFrameContext<Meta, BC> for CC
where Meta: ReceivableFrameMeta<CC, BC>,

Source§

fn receive_frame<B>(&mut self, bindings_ctx: &mut BC, metadata: Meta, frame: B)
where B: BufferMut + Debug,

Receive a frame. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<CC, BC, Meta> SendFrameContext<BC, Meta> for CC
where Meta: SendableFrameMeta<CC, BC>,

Source§

fn send_frame<S>( &mut self, bindings_ctx: &mut BC, metadata: Meta, frame: S, ) -> Result<(), ErrorAndSerializer<SendFrameErrorReason, S>>
where S: Serializer, <S as Serializer>::Buffer: BufferMut,

Send a frame. Read more
Source§

impl<Id, CC, BC> TimerHandler<BC, Id> for CC
where BC: TimerBindingsTypes, Id: HandleableTimer<CC, BC>,

Source§

fn handle_timer( &mut self, bindings_ctx: &mut BC, dispatch: Id, timer: <BC as TimerBindingsTypes>::UniqueTimerId, )

Handle a timer firing. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<L, T> UnlockedAccess<L> for T
where L: UnlockedAccessMarkerFor<T>,

§

type Data = <L as UnlockedAccessMarkerFor<T>>::Data

The type of state being accessed.
§

type Guard<'l> = &'l <L as UnlockedAccessMarkerFor<T>>::Data where T: 'l

A guard providing read access to the data.
§

fn access(&self) -> <T as UnlockedAccess<L>>::Guard<'_>

How to access the state.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<B, A> LockBefore<B> for A
where B: LockAfter<A>,