RTFW_RLY_CONFIGURATION Structure

RTFW_RLY_CONFIGURATION contains the configuration of the Network Relay component. See structure RTFW_RLY_INTERFACE for configuration parameters specific to a Network Relay interface.

Syntax

typedef struct RTFW_RLY_CONFIGURATION(
    size_t Size;
    bool AutoStart;
    bool Verbose; 
    unsigned int MainThreadIdealProcessor;
    unsigned int MainThreadPriority;
    unsigned int ExtMSpacePoolMinimumSize;
    bool MSpacePoolExpandable;
    unsigned int MSpacePoolExpandSize;
}RTFW_RLY_CONFIGURATION;

Members

Size

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

AutoStart

If TRUE, the Network Relay component automatically starts when the Subsystem starts. If FALSE, the Network Relay component does not automatically start with the Subsystem.

Verbose

If TRUE, the Network Relay component will log verbose messages. If FALSE, it will log non-verbose messages.

MainThreadIdealProcessor

The ideal processor of the main thread. This must specify the processor number of an RTSS processor, otherwise RtfwrlySetConfiguration 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 system default value from wRTOS Settings.

MainThreadPriority

The priority of the main thread. The specified value must be an integer between 0 and 127 (inclusive).

ExtMSpacePoolMinimumSize

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

MSpacePoolExpandable

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

MSpacePoolExpandSize

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