NetPeerConfiguration Members
From Lidgren.Network
| Lidgren Network Library documentation |
| NetPeerConfiguration Members |
| NetPeerConfiguration Class Constructors Methods Properties See Also Send Feedback |
The NetPeerConfiguration type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| NetPeerConfiguration |
NetPeerConfiguration constructor
|
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 | (Inherited from Object.) | |
| Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) | |
| GetHashCode |
Serves as a hash function for a particular type.
(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
| |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| SetMessageTypeEnabled |
Enables or disables receiving of the specified type of message
| |
| ToString | (Inherited from Object.) |
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.
| |
| 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
| |
| 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.
| |
| 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.
| |
| SimulatedAverageLatency |
Gets the average simulated one way latency in seconds
| |
| SimulatedDuplicatesChance |
Gets or sets the simulated amount of duplicated packets from 0.0f to 1.0f
| |
| SimulatedLoss |
Gets or sets the simulated amount of sent packets lost from 0.0f to 1.0f
| |
| SimulatedMinimumLatency |
Gets or sets the minimum simulated amount of one way latency for sent packets in seconds
| |
| SimulatedRandomLatency |
Gets or sets the simulated added random amount of one way latency for sent packets in seconds
| |
| UseMessageRecycling |
Gets or sets if the library should recycling messages to avoid excessive garbage collection. Cannot be changed once NetPeer is initialized.
|