RTFW_RLY_INTERFACE Structure

RTFW_RLY_INTERFACE represents the configuration parameters of a Network Relay interface.

Syntax

typedef struct RTFW_RLY_INTERFACE(
    size_t Size;
    TCHAR InterfaceName[RTFW_MAX_INTERFACE_NAME_CHARS];
    bool Enabled;
    unsigned int ReceivePriority;
    unsigned int ReceiveIdealProcessor;
    unsigned int TransmitPriority;
    unsigned int TransmitIdealProcessor;
    unsigned int ConfigIdealProcessor;
    unsigned int ConfigPriority;
    unsigned int RxQueueIndex;
    unsigned int RxBufferCount;
    unsigned int TxQueueIndex;
    unsigned int TxBufferCount;
} RTFW_RLY_INTERFACE;

Members

Size

The size of this structure (in bytes). Client code must set this member to sizeof(RTFW_RLY_INTERFACE) before passing this structure to any function. This is used to identify the version of this structure if it is extended.

InterfaceName

The friendly name of this interface. The maximum length of this string is 63 characters (not including the terminating null character). This member may contain only these characters: 'a' to 'z', 'A' to 'Z', '0' to '9', '_', and '-'.

Enabled

If TRUE, Network Relay functionality will be enabled for the interface specified by the InterfaceName parameter. If FALSE, Network Relay functionality will not be enabled for the specified interface.

ReceivePriority

The real-time priority of the Network Relay receive thread for this interface. This value must be between values 0 to 127 (inclusive).

ReceiveIdealProcessor

The ideal processor number for the Network Relay receive thread for this interface. Use #define RTFW_DEFAULT_RTSS_PROCESSOR UINT_MAX in RtfwApi.h to use the component’s ideal processor.

Note: This property should not be modified if the interface belongs to the Virtual Network.

TransmitPriority

The real-time priority of the Network Relay transmit thread for this interface. This value must be between values 0 to 127 (inclusive).

TransmitIdealProcessor

The ideal processor number for the Network Relay transmit thread for this interface. Use #define RTFW_DEFAULT_RTSS_PROCESSOR UINT_MAX in RtfwApi.h to use the component’s ideal processor.

ConfigIdealProcessor

The ideal processor number for the Network Relay Config thread for this interface. Use #define RTFW_DEFAULT_RTSS_PROCESSOR_UINT_MAX to specify the component’s ideal processor.

ConfigPriority

The real-time priority of the Network Relay config thread for this interface. This value must be between 0 and 127 (inclusive).

RxQueueIndex

The index of the Receive Queue that the Network Relay component will use to receive frames on this interface.

RxBufferCount

The maximum number of incoming Ethernet frames from can be queued before they are consumed by the Network Relay component.

TxQueueIndex

The index of the Transmit Queue that the Network Relay component will use to transmit frames on this interface.

TxBufferCount

The maximum number of outgoing Ethernet frames that the Network Component can queue when the Hardware Transmit Queue is full.