Rtnl2SetInterruptModeration sets the interval value for interrupt moderation.
Syntax
BOOL Rtnl2SetInterruptModeration(
[in] RTNL2_HINTERFACE Interface,
[in] ULONG MessageId,
[in] RULONG IntervalNs
);Parameters
[in] Interface
A handle to the interface.
[in] MessageId
The message ID of the MSI-X message to throttle if the InterruptType value in structure RTNL2_INTERFACE_CONFIG is RTNAL_INTERRUPT_TYPE_MSIX. The MessageId parameter must be zero (0) if the InterruptType value is not RTNAL_INTERRUPT_TYPE_MSIX.
[in] IntervalNs
The interval in nanoseconds. A zero (0) value means disable interrupt moderation.
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_DEVICE_FEATURE_NOT_SUPPORTED |
The specified interface does not support interrupt moderation. |
|
ERROR_INVALID_PARAMETER |
The value for parameter IntervalNs exceeds the hardware-dependent limit. |
Remarks
Not all hardware supports interrupt moderation. The value of parameter IntervalNs might have a hardware-dependent limit. See RTNL2_INTERFACE_FEATURES for more information.
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:
