Rtnl2StopLogicalRxQueue instructs the NL2 to stop inserting frames into the Logical Receive Queue. This can be useful if you want to atomically make several changes to the queue configuration. Typically, when the user application wants to change the filters, it will first stop the queue, change all the filters as needed, and then start the queue again.
Syntax
BOOL Rtnl2StopLogicalRxQueue(
[in] RTNL2_HLOGICAL_RX_QUEUE LogicalRxQueue,
[in] ULONG Flags
);Parameters
[in] LogicalRxQueue
A handle to the Logical Receive Queue to stop.
[in] Flags
A bitwise OR of these optional flags:
| Value | Description |
|---|---|
|
RTNL2_LOGICAL_RX_QUEUE_FLAG_FLUSH |
Empty the list of received frames. |
Return Value
BOOL Rtnl2StopLogicalRxQueue( RTNL2_HLOGICAL_RX_QUEUE hLogicalRxQueue, ULONG Flags );
Possible error codes:
| Error code | Meaning |
|---|---|
|
ERROR_NOT_READY |
The calling process has not called Rtnl2Init. |
|
ERROR_INVALID_PARAMETER |
The supplied Logical Receive Queue handle is invalid. |
|
RTNL2_ERROR_INCOMPATIBLE_REQUEST |
The supplied Flags parameter is not the result of a bitwise OR operation between a set of the supported flags defined above. This may be due to using a new SDK (that defines new flag values) with an old NL2 (that doesn’t know how to interpret those new flags). |
|
RT_ERROR_NAL_FATAL_ERROR |
Unable to communicate with the NL2 process. This might be because the NL2 process is not running anymore, or because one thread of the application process was terminated during a previous call to a NL2 API function. |
|
RT_ERROR_TIMEOUT |
The NL2 process didn’t reply within an acceptable amount of time. |
Characteristics
| Real-time | ||
|
Deterministic |
No |
|
| Local memory usage | ||
|
Process |
External MSpace usage |
Internal MSpace usage |
|
System |
No |
No |
|
NL2 process |
No |
No |
|
Calling process |
No |
No |
| Contiguous memory usage | ||
|
Usage |
No |
|
Requirements
| Minimum supported version | Header | Library |
|---|---|---|
|
eRTOS 1.0 SDK |
Rtnl2Api.h |
Rtnl2Api.lib |
See Also:
