Struct netstack3_device::queue::TransmitQueueApi

pub struct TransmitQueueApi<D, C>(/* private fields */);

An API to interact with device D transmit queues.

Implementations

impl<D, C> TransmitQueueApi<D, C>

pub fn new(ctx: C) -> Self

Creates a new TransmitQueueApi from ctx.

impl<D, C> TransmitQueueApi<D, C>

where D: Device, C: ContextPair, C::CoreContext: TransmitDequeueContext<D, C::BindingsContext> + DeviceSocketHandler<D, C::BindingsContext>, for<'a> <C::CoreContext as TransmitDequeueContext<D, C::BindingsContext>>::TransmitQueueCtx<'a>: ResourceCounterContext<<C::CoreContext as DeviceIdContext<D>>::DeviceId, DeviceCounters>, C::BindingsContext: TransmitQueueBindingsContext<<C::CoreContext as DeviceIdContext<D>>::DeviceId>,

pub fn transmit_queued_frames( &mut self, device_id: &<C::CoreContext as DeviceIdContext<D>>::DeviceId, batch_size: BatchSize, dequeue_context: &mut <C::CoreContext as TransmitQueueCommon<D, C::BindingsContext>>::DequeueContext, ) -> Result<WorkQueueReport, DeviceSendFrameError>

Transmits any queued frames.

Up to batch_size frames will attempt to be dequeued and sent in this call.

dequeue_context is directly given to the context to operate on each individual frame.

pub fn count( &mut self, device_id: &<C::CoreContext as DeviceIdContext<D>>::DeviceId, ) -> Option<usize>

Returns the number of frames in device_id’s TX queue.

Returns None if the device doesn’t have a queue configured.

pub fn set_configuration( &mut self, device_id: &<C::CoreContext as DeviceIdContext<D>>::DeviceId, config: TransmitQueueConfiguration, )

Sets the queue configuration for the device.