RTFW_NL2_CONFIGURATION

RTFW_NL2_CONFIGURATION contains the configuration of the Network Link Layer (NL2). See structure RTFW_NL2_INTERFACE for configuration parameters specific to a network interface.

Syntax

typedef struct _RTFW_NL2_CONFIGURATION(
    size_t Size;
    bool AutoStart;
    bool Verbose;
    DWORD IdealProcessor;
    unsigned int Priority;
    unsigned int ExtMSpacePoolMinimumSize;
    bool MSpacePoolExpandable;
    unsigned int MSpacePoolExpandSize;
} RTFW_NL2_CONFIGURATION, * PRTFW_NL2_CONFIGURATION;

Members

Size

The size of this structure (in bytes). Client code must set this member to sizeof(RTFW_NL2_CONFIGURATION) before passing this structure to any function.

AutoStart

If TRUE, the NL2 automatically starts when the Subsystem starts. If FALSE, the NL2 does not automatically start with the Subsystem.

IdealProcessor

The ideal processor of the main thread. This must specify the processor number of an RTSS processor, otherwise RtfwNL2SetConfiguration fails and sets the last error value to ERROR_INVALID_PARAMETER. Use #define RTFW_DEFAULT_RTSS_PROCESSOR UINT_MAX in RtfwApi.h to use the parent thread’s ideal processor or the system default value from wRTOS Settings.

Priority

The priority of the main thread. The specified value must be a non-negative integer referencing an RTSS processor number.

ExtMSpacePoolMinimumSize

The initial size, in bytes, of the NL2 external MSpace pool.

MSpacePoolExpandable

If set to TRUE, the NL2 external MSpace can expand. If set to FALSE, the NL2 external MSpace cannot expand.

MSpacePoolExpandSize

The expand size, in bytes, for the NL2 external MSpace. This value is ignored when MSpacePoolExpandable is FALSE.

Requirements

See Also:

• RTFW_NL2_INTERFACE
• RTFW_SUBSYSTEM_CONFIGURATION
• RtfwNL2GetConfiguration
• RtfwNL2SetConfiguration