NDK_FN_ARM_CQ callback function (ndkpi.h)

Article
02/22/2024

The NdkArmCq (NDK_FN_ARM_CQ) function arms an NDK completion queue (CQ) notification.

Syntax

NDK_FN_ARM_CQ NdkFnArmCq;

void NdkFnArmCq(
  [in] NDK_CQ *pNdkCq,
  [in] ULONG Type
)
{...}

Parameters

[in] pNdkCq

A pointer to an NDK completion queue object (NDK_CQ).

[in] Type

The type of notification to arm. The following notification types are defined:

Term	Description
NDK_CQ_NOTIFY_ERRORS	Notify if there are any completion queue errors such as a completion queue overrun or catastrophic failure.
NDK_CQ_NOTIFY_ANY	Notify of the next successful completion in the completion queue.
NDK_CQ_NOTIFY_SOLICITED	Notify when the completion queue receives a send request that includes the ND_OP_FLAG_SEND_AND_SOLICIT_EVENT flag.

Return value

None

Remarks

After the NDK consumer arms a completion queue (CQ) notification, the provider calls the NdkCqNotificationCallback callback function (the NDK_FN_CQ_NOTIFICATION_CALLBACK routine that the consumer specified when the CQ was created with the NdkCreateCq (NDK_FN_CREATE_CQ) function) when the specified type of notification is due.

If the CQ is closed while a call to NdkCqNotificationCallback is in-progress, the close request will remain pending until NdkCqNotificationCallback returns control to the provider. After the close request is completed, the provider will not call NdkCqNotificationCallback.

Requirements

Requirement	Value
Minimum supported client	None supported,Supported in NDIS 6.30 and later.
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	ndkpi.h (include Ndkpi.h)
IRQL	<=DISPATCH_LEVEL