Photon Bolt Engine API
Networking Middleware
Public Member Functions | Public Attributes | List of all members
BoltConfig Class Reference

Bolt configuration settings object More...

Public Member Functions

 BoltConfig ()
 

Public Attributes

int framesPerSecond = 60
 The number of fixed updates to the simulation per second More...
 
int packetSize = 1280
 The UDP packet size in bytes More...
 
int packetMaxEventSize = 512
 The max data payload size of a packet More...
 
int maxEntityPriority = 1 << 16
 The max priority value for updating an entity More...
 
int maxPropertyPriority = 1 << 11
 The max priority value for updating a property More...
 
Bolt.ScopeMode scopeMode = Bolt.ScopeMode.Automatic
 Whether to scope connections manually or automatically More...
 
BoltConfigLogTargets logTargets = BoltConfigLogTargets.Console | BoltConfigLogTargets.Unity
 The output targets to write log messages More...
 
bool disableDejitterBuffer
 Whether dejitter delay buffering is disabled or not More...
 
int clientSendRate
 
int clientDejitterDelay
 
int clientDejitterDelayMin
 
int clientDejitterDelayMax
 
int serverSendRate
 
int serverDejitterDelay
 
int serverDejitterDelayMin
 
int serverDejitterDelayMax
 
int serverConnectionLimit
 The max number of server connections More...
 
BoltConnectionAcceptMode serverConnectionAcceptMode = BoltConnectionAcceptMode.Auto
 Whether to use automatic or manual mode for accepting incoming client connection requests More...
 
int commandDejitterDelay
 
int commandQueueSize
 The max number of input commands that can be queued at once More...
 
int commandDelayAllowed
 
int commandRedundancy
 The number of times to redundantly send input commands to the server More...
 
float commandPingMultiplier
 
bool useNetworkSimulation = true
 Whether to use network latency simulation More...
 
float simulatedLoss
 The packet loss rate to use in latency simulation More...
 
int simulatedPingMean
 The mean ping in milliseconds to use in latency simulation More...
 
int simulatedPingJitter
 The deviation to use in ping simulation More...
 
BoltRandomFunction simulatedRandomFunction = BoltRandomFunction.PerlinNoise
 Whether to use Perlin Noise or System.Random function to create ping deviations More...
 
int connectionTimeout = 10000
 
int connectionRequestTimeout = 500
 
int connectionRequestAttempts = 20
 The max number of allowed connection attempts by a single client More...
 

Detailed Description

Bolt configuration settings object

Example: Starting a bolt server simulation internally requires a config parameter (there is a bit more to it not shown here).

1 static void Initialize(BoltNetworkModes modes, UdpEndPoint endpoint, BoltConfig config) {
2 
3  BoltNetworkInternal.__Initialize(modes, endpoint, config, CreateUdpPlatform());

Constructor & Destructor Documentation

BoltConfig.BoltConfig ( )
inline

Member Data Documentation

int BoltConfig.clientDejitterDelay
int BoltConfig.clientDejitterDelayMax
int BoltConfig.clientDejitterDelayMin
int BoltConfig.clientSendRate
int BoltConfig.commandDejitterDelay
int BoltConfig.commandDelayAllowed
float BoltConfig.commandPingMultiplier
int BoltConfig.commandQueueSize

The max number of input commands that can be queued at once

int BoltConfig.commandRedundancy

The number of times to redundantly send input commands to the server

int BoltConfig.connectionRequestAttempts = 20

The max number of allowed connection attempts by a single client

int BoltConfig.connectionRequestTimeout = 500
int BoltConfig.connectionTimeout = 10000
bool BoltConfig.disableDejitterBuffer

Whether dejitter delay buffering is disabled or not

int BoltConfig.framesPerSecond = 60

The number of fixed updates to the simulation per second

BoltConfigLogTargets BoltConfig.logTargets = BoltConfigLogTargets.Console | BoltConfigLogTargets.Unity

The output targets to write log messages

int BoltConfig.maxEntityPriority = 1 << 16

The max priority value for updating an entity

int BoltConfig.maxPropertyPriority = 1 << 11

The max priority value for updating a property

int BoltConfig.packetMaxEventSize = 512

The max data payload size of a packet

int BoltConfig.packetSize = 1280

The UDP packet size in bytes

Bolt.ScopeMode BoltConfig.scopeMode = Bolt.ScopeMode.Automatic

Whether to scope connections manually or automatically

BoltConnectionAcceptMode BoltConfig.serverConnectionAcceptMode = BoltConnectionAcceptMode.Auto

Whether to use automatic or manual mode for accepting incoming client connection requests

int BoltConfig.serverConnectionLimit

The max number of server connections

int BoltConfig.serverDejitterDelay
int BoltConfig.serverDejitterDelayMax
int BoltConfig.serverDejitterDelayMin
int BoltConfig.serverSendRate
float BoltConfig.simulatedLoss

The packet loss rate to use in latency simulation

int BoltConfig.simulatedPingJitter

The deviation to use in ping simulation

int BoltConfig.simulatedPingMean

The mean ping in milliseconds to use in latency simulation

BoltRandomFunction BoltConfig.simulatedRandomFunction = BoltRandomFunction.PerlinNoise

Whether to use Perlin Noise or System.Random function to create ping deviations

bool BoltConfig.useNetworkSimulation = true

Whether to use network latency simulation