EVT_PACKET_QUEUE_STOP callback function (netpacketqueue.h)

Article
02/22/2024

The EvtPacketQueueStop callback function is an optional callback that is implemented by the client driver to stop the data path for a packet queue.

Syntax

EVT_PACKET_QUEUE_STOP EvtPacketQueueStop;

void EvtPacketQueueStop(
  [_In_] NETPACKETQUEUE PacketQueue
)
{...}

Parameters

[_In_] PacketQueue

A handle to a packet queue.

Return value

None

Remarks

This is an optional callback. Register this callback function in your EVT_NET_ADAPTER_CREATE_TX(rxQueueContext)QUEUE callback. Set the appropriate member of a NET_PACKET_QUEUE_CONFIG structure after you initialize the structure with NET_PACKET_QUEUE_CONFIG_INIT, then call NetTx(rxQueueContext)QueueCreate.

This callback does not return a value and therefore should not fail, so this callback should be a light-weight function that executes quickly.

Client drivers will not receive calls to EVT_PACKET_QUEUE_ADVANCE, EVT_PACKET_QUEUE_CANCEL, or EVT_PACKET_QUEUE_SET_NOTIFICATION_ENABLED after EvtPacketQueueStop returns. In addition, EvtPacketQueueStop is called in the same execution context, or thread, as EvtPacketQueueAdvance, EvtPacketQueueCancel, and EvtPacketQueueSetNotificationEnabled, so client drivers do not need to synchronize between these callback functions for an individual queue instance.

For more info and a diagram showing the NetAdapterCx data path polling model, see Transmit and receive queues.

Requirements

Requirement	Value
Target Platform	Universal
Minimum KMDF version	1.27
Header	netpacketqueue.h (include netadaptercx.h)
IRQL	PASSIVE_LEVEL