NetPeerConfiguration Class |
Partly immutable after NetPeer has been initialized
Inheritance HierarchyNamespace: Internal.Lidgren.Network
Assembly: NeoAxis.Core (in NeoAxis.Core.dll) Version: 2024.1.1.0 (2024.1.1.0)
SyntaxC#
public sealed class NetPeerConfiguration
The NetPeerConfiguration type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | NetPeerConfiguration |
NetPeerConfiguration constructor
|
Properties| Name | Description | |
|---|---|---|
 | AcceptIncomingConnections |
Gets or sets if the NetPeer should accept incoming connections. This is automatically set to true in NetServer and false in NetClient.
|
| AppIdentifier |
Gets the identifier of this application; the library can only connect to matching app identifier peers
|
| AutoExpandMTU |
Gets or sets if the NetPeer should send large messages to try to expand the maximum transmission unit size
|
| AutoFlushSendQueue |
Enables or disables automatic flushing of the send queue. If disabled, you must manully call NetPeer.FlushSendQueue() to flush sent messages to network.
|
| BroadcastAddress |
Gets or sets the local broadcast address to use when broadcasting
|
| ConnectionTimeout |
Gets or sets the number of seconds timeout will be postponed on a successful ping/pong
|
| DefaultOutgoingMessageCapacity |
Gets or sets the default capacity in bytes when NetPeer.CreateMessage() is called without argument
|
| DualStack |
Gets or sets a value indicating whether the library should use IPv6 dual stack mode.
If you enable this you should make sure that the LocalAddress is an IPv6 address.
Cannot be changed once NetPeer is initialized.
|
| EnableUPnP |
Enables UPnP support; enabling port forwarding and getting external ip
|
| ExpandMTUFailAttempts |
Gets or sets the number of failed expand mtu attempts to perform before setting final MTU
|
| ExpandMTUFrequency |
Gets or sets how often to send large messages to expand MTU if AutoExpandMTU is enabled
|
| LocalAddress |
Gets or sets the local ip address to bind to. Defaults to IPAddress.Any. Cannot be changed once NetPeer is initialized.
|
| MaximumConnections |
Gets or sets the maximum amount of connections this peer can hold. Cannot be changed once NetPeer is initialized.
|
| MaximumHandshakeAttempts |
Gets or sets the maximum number of handshake attempts before failing to connect
|
| MaximumTransmissionUnit |
Gets or sets the maximum amount of bytes to send in a single packet, excluding ip, udp and lidgren headers. Cannot be changed once NetPeer is initialized.
|
| NetworkThreadName |
Gets or sets the name of the library network thread. Cannot be changed once NetPeer is initialized.
|
| PingInterval |
Gets or sets the time between latency calculating pings
|
| Port |
Gets or sets the local port to bind to. Defaults to 0. Cannot be changed once NetPeer is initialized.
|
| ReceiveBufferSize |
Gets or sets the size in bytes of the receiving buffer. Defaults to 131071 bytes. Cannot be changed once NetPeer is initialized.
|
| RecycledCacheMaxCount |
Gets or sets the maximum number of incoming/outgoing messages to keep in the recycle cache.
|
| ResendHandshakeInterval |
Gets or sets the number of seconds between handshake attempts
|
| SendBufferSize |
Gets or sets the size in bytes of the sending buffer. Defaults to 131071 bytes. Cannot be changed once NetPeer is initialized.
|
| SuppressUnreliableUnorderedAcks |
If true, will not send acks for unreliable unordered messages. This will save bandwidth, but disable flow control and duplicate detection for this type of messages.
|
| UnreliableSizeBehaviour |
Gets or sets the behaviour of unreliable sends above MTU
|
| UseMessageRecycling |
Gets or sets if the library should recycling messages to avoid excessive garbage collection. Cannot be changed once NetPeer is initialized.
|
Methods| Name | Description | |
|---|---|---|
| Clone |
Creates a memberwise shallow clone of this configuration
|
| DisableMessageType |
Disables receiving of the specified type of message
|
| EnableMessageType |
Enables receiving of the specified type of message
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsMessageTypeEnabled |
Gets if receiving of the specified type of message is enabled
|
| SetMessageTypeEnabled |
Enables or disables receiving of the specified type of message
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
  | kDefaultMTU |
Default MTU value in bytes
|
Extension Methods| Name | Description | |
|---|---|---|
 | MethodInvoke |
Calls the object method by name.
(Defined by ObjectEx.) |
| PropertyGet(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertyGetT(String, Object, Boolean) | Overloaded.
Gets the value of the object property by name.
(Defined by ObjectEx.) |
| PropertySet |
Sets the value of the object property by name.
(Defined by ObjectEx.) |
See Also