Rtnl2GetPhysicalRxQueueMode

Rtnl2GetPhysicalRxQueueMode gets the current setting value of the interface mode.

Syntax

Copy 
BOOL Rtnl2GetPhysicalRxQueueMode(
  [in]    RTNL2_HPHYSICAL_RX_QUEUE PhysicalRxQueue, 
  [in]    RTNL2_RX_MODE_SETTING Setting, 
  [out]   BOOL *Requested, 
  [out]   BOOL *Actual
);

Parameters

[in] PhysicalRxQueue

A handle to the Physical Receive Queue by calling Rtnl2AcquirePhysicalRxQueue.

[in] Setting

The identifier of the setting to query. See RTNL2_RX_MODE_SETTING for mode setting

[out] Requested

The value which has been requested through this Physical 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:

  • The supplied Physical Receive Queue handle is invalid.
  • Parameter Setting doesn’t correspond to any setting known by this NL2 version.
  • Both the Requested and Actual parameters are NULL.

RTNL2_ERROR_PHYSICAL_RX_QUEUE_IS_RELEASING

Another thread of the calling process is executing Rtnl2ReleasePhysicalRxQueue at the same time.

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 Rtnl2SetPhysicalRxQueueMode. Parameter Requested represents the setting value maintained by the NL2 for this Physical 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: