EVT_PACKET_QUEUE_SET_NOTIFICATION_ENABLED callback function (netpacketqueue.h)

Article
02/22/2024

The EvtPacketQueueSetNotificationEnabled callback function is implemented by the client driver to perform client-specific processing when there are new packets received in the specified queue's ring buffer.

Syntax

EVT_PACKET_QUEUE_SET_NOTIFICATION_ENABLED EvtPacketQueueSetNotificationEnabled;

void EvtPacketQueueSetNotificationEnabled(
  [_In_] NETPACKETQUEUE PacketQueue,
  [_In_] BOOLEAN NotificationEnabled
)
{...}

Parameters

[_In_] PacketQueue

A handle to a packet queue.

[_In_] NotificationEnabled

A value of TRUE requests that the client enable packet queue notification. A value of FALSE requests that the client disable packet queue notification.

Return value

None

Remarks

Register this callback function in your EVT_NET_ADAPTER_CREATE_TX(RX)QUEUE callback. Set the appropriate member of a NET_PACKET_QUEUE_CONFIG structure when you are initializing the structure with NET_PACKET_QUEUE_CONFIG_INIT, then call NetTx(Rx)QueueCreate.

NetAdapterCx serializes this callback function along with the packet queue's EVT_PACKET_QUEUE_CANCEL and EVT_PACKET_QUEUE_ADVANCE callback functions.

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