RTFW_NETWORK_CONFIGURATION Structure

RTFW_NETWORK_CONFIGURATION represents the configuration of the RT-TCP/IP Stack. See structure RTFW_NETWORK_INTERFACE for configuration parameters specific to a network interface.

Syntax

typedef struct _RTFW_NETWORK_CONFIGURATION(
    size_t Size;
    unsigned int Memory;
    bool Verbose;
    bool AutoStart;
    unsinged int IdealProcessor;
    unsigned int MaxSockets;
    unsigned int MaxARPEntries;
    unsigned int IPReassemblyTimeout;
    unsigned int MTU;
    unsigned int TickInterval;
    unsigned int TimerIdealProcessor;
    unsigned int TimerPriority;
} RTFW_NETWORK_CONFIGURATION, * PRTFW_NETWORK_CONFIGURATION;

Members

Size

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

Memory

The amount of memory (in kilobytes) to be allocated for the RT-TCP/IP Stack’s internal resources.

Verbose

If true, the Stack operates in verbose mode, displaying information about Stack initialization and configuration. If false, the Stack does not display any information.

AutoStart

If true, the Stack automatically starts when the subsystem starts. If false, the Stack does not automatically start.

IdealProcessor

The RT-TCP/IP Stack's ideal processor. This must specify the processor number of an RTSS processor, otherwise RtfwSetNetworkConfiguration fails and sets the last error value to ERROR_INVALID_PARAMETER. If this value is RTFW_FIRST_RTSS_PROCESSOR, it refers to the first RTSS processor, regardless of the actual number of the first RTSS processor.

MaxSockets

The maximum number of sockets supported by the Stack. Valid values are in the range 1 to 32765 (inclusive).

MaxARPEntries

The maximum number of ARP entries supported by the RT-TCP/IP Stack. Valid values are in the range 1 to 65,535 (inclusive).

IPReassemblyTimeout

The period (in seconds) for the RT-TCP/IP Stack to wait before timing out on reassembly of a fragmented IP packet. Valid values are in the range 1 to 127 (inclusive).

MTU

The default Maximum Transmission Unit (MTU) size (in bytes) of the RT-TCP/IP Stack. Valid values are in the range 1500 to 9000 (inclusive).

TickInterval

The RT-TCP/IP Stack’s tick interval. This is the fundamental granularity of all time-related operations within the RT-TCP/IP Stack. This must be a multiple of the HAL timer period (see structure RTFW_SUBSYSTEM_CONFIGURATION). If the HAL timer period is changed using RtfwSetSubsystemConfiguration, and the RT-TCP/IP Stack tick interval is not an integer multiple of the new HAL timer period, the RT-TCP/IP Stack tick interval is changed to be the next higher integer multiple of the HAL timer period.

TimerIdealProcessor

The ideal processor of the RT- TCP/IP Stack's timer thread. This must specify the processor number of an RTSS processor, otherwise RtfwSetNetworkConfiguration fails and sets the last error value to ERROR_INVALID_PARAMETER. If this value is zero or RTFW_FIRST_RTSS_PROCESSOR, it refers to the same RTSS processor that is configured by member IdealProcessor, which is not necessarily the first RTSS processor.

TimerPriority

The priority of the RT-TCP/IP Stack's real-time timer thread. This value must be in the range of valid RTX64 real-time priorities: 0 to 127 (inclusive).

Requirements

Minimum Required Version	RTX64 3.4
Header	RtfwAPI.h
Library	RtfwAPI.lib