Class NetworkConfig

Low-level network configuration structure. Provides settings for the network driver and all internal components.

System.Object
NetworkConfig
Namespace: FlaxEngine.Networking
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class NetworkConfig : ValueType

Fields

Address

Address used to connect to or listen at.

Declaration
public string Address
Field Value
System.String

Remarks

Set it to "any" when you want to listen at all available addresses.

ConnectionsLimit

The upper limit on how many peers can join when we're listening.

Declaration
public ushort ConnectionsLimit
Field Value
System.UInt16

MessagePoolSize

The amount of pooled messages that can be used at once (receiving and sending!).

Declaration
public ushort MessagePoolSize
Field Value
System.UInt16

Remarks

Creating more messages than this limit will result in a crash! This should be tweaked manually to fit the needs (adjusting this value will increase/decrease memory usage)!

MessageSize

The size of a message buffer in bytes. Should be lower than the MTU (maximal transmission unit) - typically 1500 bytes.

Declaration
public ushort MessageSize
Field Value
System.UInt16

NetworkDriver

The network driver instance (implements INetworkDriver) that will be used to create and manage the peer, send and receive messages.

Declaration
public Object NetworkDriver
Field Value
Object

Remarks

Object is managed by the created network peer (will be deleted on peer shutdown).

NetworkDriverType

The network driver that will be used to create the peer. To allow two peers to connect, they must use the same host. [Deprecated in v1.3]

Declaration
public NetworkDriverType NetworkDriverType
Field Value
NetworkDriverType

Port

The port to connect to or listen at.

Declaration
public ushort Port
Field Value
System.UInt16

Properties

Default

The default NetworkConfig.

Declaration
public static NetworkConfig Default { get; }
Property Value
NetworkConfig

Extension Methods