RtndfltManageRxQueue

RtndfltManageRxQueue initializes an instance of the filter driver for the specified Rx Queue.

Syntax

Copy
BOOL RtndfltManageRxQueue(
  [in]    RTND_INTERFACE_OBJECT *pNL2Interface,
  [in]    CHAR *pInterfaceName,
  [in}    ULONG RxQueueIndex,
  [out]   ULONG_PTR *pRtndRxQueueId
);

Parameters

[in] pNL2Interface

The opaque pointer used by the NL2 to identify this interface.

[in] pInterfaceName

The address of a null-terminated string containing the name of the interface assigned by the user.

[in] RxQueueIndex

The index of the Rx Queue for which a filter driver is being initialized.

[out] pRtndRxQueueId

The number or pointer used by the NIC driver to identify this interface.

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. To get extended error information, call GetLastError.

Common error codes:

Error code Meaning

ERROR_OUTOFMEMORY

Failed to allocate the required memory.

Note: Custom drivers may return other error codes not listed above.

Remarks

The NL2 always calls this function from the main thread of the NL2 process.

This function typically allocates a context for the specified Rx Queue and assigns a number to it, which is returned in pRtndfltRxQueueId. The NL2 can then use this number to identify this Rx Queue in all subsequent function calls.

The pInterfaceName parameter is strictly informational. It is given for convenience if the filter driver has logging capability, or if it is built in debug mode and wants to print messages on the console output. The filter driver can copy all string content or reference it as a pointer. The NL2 guarantees that the content at this address will always contain the name of the interface.

Characteristics

Real-time requirements

Deterministic behavior

Not required

Shutdown-safe behavior

Not required

Local memory allocation/deallocation restrictions

Process

External MSpace

Internal MSpace

System

Allowed

Allowed

RTSS process

Allowed

Allowed

Windows contiguous memory allocation/deallocation restrictions

Contiguous memory

Allowed

Requirements

Minimum supported version Header

wRTOS 1.0 SDK

Rtnd.h

See Also: