netstack3_device::socket

Struct DeviceSocketApi

Source 
pub struct DeviceSocketApi<C>(/* private fields */);
Expand description

The device socket API.

Implementations§

Source§

impl<C> DeviceSocketApi<C>

Source

pub fn new(ctx: C) -> Self

Creates a new DeviceSocketApi for ctx.

Source§

impl<C> DeviceSocketApi<C>
where C: ContextPair, C::CoreContext: DeviceSocketContext<C::BindingsContext> + SocketStateAccessor<C::BindingsContext>, C::BindingsContext: DeviceSocketBindingsContext<<C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId> + ReferenceNotifiers + 'static,

Source

pub fn create( &mut self, external_state: <C::BindingsContext as DeviceSocketTypes>::SocketState, ) -> DeviceSocketId<<<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>

Creates an packet socket with no protocol set configured for all devices.

Source

pub fn set_device( &mut self, socket: &DeviceSocketId<<<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, device: TargetDevice<&<C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>, )

Sets the device for which a packet socket will receive packets.

Source

pub fn set_device_and_protocol( &mut self, socket: &DeviceSocketId<<<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, device: TargetDevice<&<C::CoreContext as DeviceIdContext<AnyDevice>>::DeviceId>, protocol: Protocol, )

Sets the device and protocol for which a socket will receive packets.

Source

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

Gets the bound info for a socket.

Source

pub fn remove( &mut self, id: DeviceSocketId<<<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, ) -> RemoveResourceResultWithContext<<C::BindingsContext as DeviceSocketTypes>::SocketState, C::BindingsContext>

Removes a bound socket.

Source

pub fn send_frame<S, D>( &mut self, _id: &DeviceSocketId<<<C as ContextPair>::CoreContext as DeviceIdContext<AnyDevice>>::WeakDeviceId, <C as ContextPair>::BindingsContext>, metadata: DeviceSocketMetadata<D, <C::CoreContext as DeviceIdContext<D>>::DeviceId>, body: S, ) -> Result<(), SendFrameErrorReason>
where S: Serializer, S::Buffer: BufferMut, D: DeviceSocketSendTypes, C::CoreContext: DeviceIdContext<D> + SendFrameContext<C::BindingsContext, DeviceSocketMetadata<D, <C::CoreContext as DeviceIdContext<D>>::DeviceId>>, C::BindingsContext: DeviceLayerTypes,

Sends a frame for the specified socket.

Auto Trait Implementations§

§

impl<C> Freeze for DeviceSocketApi<C>
where C: Freeze,

§

impl<C> RefUnwindSafe for DeviceSocketApi<C>
where C: RefUnwindSafe,

§

impl<C> Send for DeviceSocketApi<C>
where C: Send,

§

impl<C> Sync for DeviceSocketApi<C>
where C: Sync,

§

impl<C> Unpin for DeviceSocketApi<C>
where C: Unpin,

§

impl<C> UnwindSafe for DeviceSocketApi<C>
where C: 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>,