public record class SessionOptionsHow a session behaves.
No guide page documents this yet — the page shows what the code says about itself.
Fields and properties (15)
public uint ProtocolVersionThe version of the wire protocol and of the game's own messages. A client whose number differs is refused at the handshake with ProtocolMismatch rather than being allowed in to misinterpret packets.
public ulong ContentHashA hash of the content build both sides are running.
public int MaxPlayersThe most players allowed at once. Reconnecting players still hold their slot.
public TickRate TickRateHow often the simulation ticks.
public TimeSpan ReconnectWindowHow long a dropped player's slot, entities and id are held for them.
public TimeSpan AuthenticationTimeoutHow long an authenticator may take before the connection is refused.
public TimeSpan PingIntervalHow often each side measures the round trip.
public TimeSpan TimeoutHow long silence from a peer lasts before the connection is treated as gone.
public byte[] AuthenticationPayloadWhat a client sends to be let in. Opaque to the session.
public int MaxAuthenticationPayloadBytesThe most bytes a client's authentication payload may be.
public int BytesPerSecondPerPlayerWhat one peer's own messages may cost, in bytes a second. Zero is no budget at all.
public int BurstBytesHow much of the budget may be saved up and spent at once.
public double ReservedFractionHow much of the bucket only important messages may spend.
public int ReservedPriorityThe priority a message needs before it may spend the reserve.
public NetworkSimulationSettings? SimulationA bad network to pretend to be on, or for the real one. Set, the session wraps its transport in a NetworkSimulation before it uses it.
Used by (17)
- GameClientMultiplayer
- GameServerMultiplayer
- LocalMatchMultiplayer
- HandshakeTargetVixen.Fuzz
- HandshakeTraceTestsVixen.Net.Tests
- NetworkMetricsTestsVixen.Net.Tests
- NetworkSessionVixen.Net
- SessionBandwidthTestsVixen.Net.Tests
- SessionHarnessVixen.Net.Tests
- SessionLinkReportTestsVixen.Net.Tests
- SessionSimulationTestsVixen.Net.Tests
- SessionTestsVixen.Net.Tests
- NetworkViewTestsVixen.Editor.Debugger.Tests
- RealmVixen.Live.Realm
- RealmVixen.Live.Realm.Tests
- RealmClusterTestsVixen.Live.Realm.Cluster.Tests
- RealmFixtureVixen.Live.Realm.Tests