Photon Fusion 2.0.0

Public Types | Public Member Functions | Public Attributes | Properties | List of all members
NetworkConfiguration Class Reference

Main network configuration class. More...

Public Types

enum  ReliableDataTransfers
 Flag for allowed Reliable Data transfer modes. More...
 

Public Member Functions

NetworkConfiguration Init ()
 Initializes and creates a copy of this NetworkProjectConfig.
 

Public Attributes

double ConnectionShutdownTime = 1
 Default delay between connection changes status to Shutdown (disconnected/invalid), and it actually being released (freeing all references to that particular connection).
 
double ConnectionTimeout = 10
 Max allowed time in seconds that the local peer can run without receiving any update from a remote peer. If a client does not receive any update from the server within this period, it will disconnect itself. If a server does not receive any update from a remote client within this period, it will disconnect that particular client.
 
ReliableDataTransfers ReliableDataTransferModes
 Current ReliableDataTransferModes mode.
 

Properties

int ConnectAttempts [get]
 Max number of connection attempts that a Client will run when trying to connect to a remote Server.
 
double ConnectInterval [get]
 Interval in seconds between each connection attempt from a Client.
 
double ConnectionDefaultRtt [get]
 Default assumed RTT in seconds for new connections (before actual RTT has been determined). The real RTT is calculated over time once the connection is established.
 
double ConnectionPingInterval [get]
 Interval in seconds between PING messages sent to a remote connection, in order to keep that connection alive.
 
int MtuDefault [get]
 Max number of bytes that can be used by Fusion to fill up a UDP package.
 
int SocketRecvBufferSize [get]
 Size in Kilobytes of the underlying socket receive buffer.
 
int SocketSendBufferSize [get]
 Size in Kilobytes of the underlying socket send buffer.
 

Detailed Description

Main network configuration class.

Member Enumeration Documentation

◆ ReliableDataTransfers

Flag for allowed Reliable Data transfer modes.

Enumerator
ClientToServer 

Allow Client to Server.

ClientToClientWithServerProxy 

Allow Client to Client using Server as Proxy.

Member Function Documentation

◆ Init()

Initializes and creates a copy of this NetworkProjectConfig.

Returns
A copy of this NetworkProjectConfig.

Member Data Documentation

◆ ReliableDataTransferModes

ReliableDataTransfers ReliableDataTransferModes
Initial value:
=
ReliableDataTransfers.ClientToServer |
ReliableDataTransfers.ClientToClientWithServerProxy
ReliableDataTransfers
Flag for allowed Reliable Data transfer modes.
Definition SimulationConfig.NetworkConfiguration.cs:20

Current ReliableDataTransferModes mode.

Property Documentation

◆ ConnectionPingInterval

double ConnectionPingInterval
get

Interval in seconds between PING messages sent to a remote connection, in order to keep that connection alive.

Currently unused.