Rtnl2GetLogicalRxQueueMode
Rtnl2GetLogicalRxQueueMode gets the current setting value of the interface mode.
Syntax
BOOL Rtnl2GetLogicalRxQueueMode(
[in] RTNL2_HLOGICAL_RX_QUEUE LogicalRxQueue,
[in] RTNL2_RX_MODE_SETTING Setting,
[out] BOOL *Requested,
[out] BOOL *Actual
);
Parameters
[in] LogicalRxQueue
A handle to the Logical Receive Queue.
[in] Setting
The identifier of the setting to query.
[out] Requested
The value which has been requested through this Logical Receive Queue handle.
[out] Actual
The actual hardware value of the setting.
Return Value
If the function succeeds, it returns TRUE. If the function fails, it returns FALSE. Call GetLastError to obtain an error code.
Possible error codes:
| Error code | Meaning |
|---|---|
|
ERROR_NOT_READY |
The calling process has not called Rtnl2Init. |
|
ERROR_INVALID_PARAMETER |
One of the following conditions occurred:
|
|
RTNL2_ERROR_SERIALIZED_COMMAND_TIMEOUT |
The NL2 process didn’t reply within an acceptable delay. |
|
RTNL2_ERROR_NO_MORE_COMMUNICATION |
Unable to communicate with the NL2 process. This might be because the NL2 process is not running anymore, or because an application process thread was terminated during a previous call to an NL2 API function. |
Remarks
The NL2 maintains a per-queue copy of each interface mode setting. The setting value in the per-queue copy is updated when an application calls Rtnl2SetLogicalRxQueueMode. Parameter Requested represents the setting value maintained by the NL2 for this Logical Receive Queue, while parameter Actual represents the actual setting value in the hardware.
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: