RTFW_NL2_INTERFACE_TXQUEUE Structure

RTFW_NL2_INTERFACE_TXQUEUE contains transmit queue information for a Network Link Layer (NL2) interface.

Syntax

Copy

typedef struct RTFW_NL2_INTERFACE_TXQUEUE {
    size_t Size;
    unsigned int Index;                       
    bool Enabled;                      
    unsigned int BufferCount;  
    bool TimestampingEnabled;
    unsigned int ManagementThreadIdealProcessor;   
    unsigned int ManagementThreadPriority; 
    unsigned int MSIXQueueMessageId; 
    bool LaunchTimeEnabled;
    bool CbsEnabled;
} RTFW_NL2_INTERFACE_TXQUEUE, * PRTFW_NL2_INTERFACE_TXQUEUE;

Members

Size

The size of the caller's copy of this structure for version control. This MUST be set to sizeof(RTFW_NL2_INTERFACE_TXQUEUE).

Index

The hardware index of the queue. This value must be unique among all transmit queues for the interface.

Enabled

If TRUE, the queue is enabled. If FALSE, the queue is disabled.

BufferCount

The number of buffers to allocate at startup. When this value is set to 0, the driver uses the hardware default. Some drivers allow a specific non-default number of buffers to be allocated at startup.

TimestampingEnabled

Determines whether timestamping is enabled for this queue.

ManagementThreadIdealProcessor

The ideal processor of the NL2 Queue Management Thread for this queue.

ManagementThreadPriority

The priority of the NL2 Queue Management Thread for this queue.

MSIXQueueMessageId

The ID of the MSI-X queue message. This value must match the MSIXMessageID of an enabled MSI-X message if the interface’s InterruptType is RTIN_MSIX.

LaunchTimeEnabled

Determines whether Launch Time is enabled for this queue.

CbsEnabled

Determines whether Credit-based Shaping (CBS) is enabled for this queue.

Remarks

See Device-Specific Interface Values for device-specific defaults and value ranges.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	Rtfwnl2Api.h	Rtfwnl2Api.lib