Vixen
dd8b0a81
csharp
public record class SessionOptions

How a session behaves.

No guide page documents this yet — the page shows what the code says about itself.

Fields and properties (15)

  • public uint ProtocolVersion

    The 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 ContentHash

    A hash of the content build both sides are running.

  • public int MaxPlayers

    The most players allowed at once. Reconnecting players still hold their slot.

  • public TickRate TickRate

    How often the simulation ticks.

  • public TimeSpan ReconnectWindow

    How long a dropped player's slot, entities and id are held for them.

  • public TimeSpan AuthenticationTimeout

    How long an authenticator may take before the connection is refused.

  • public TimeSpan PingInterval

    How often each side measures the round trip.

  • public TimeSpan Timeout

    How long silence from a peer lasts before the connection is treated as gone.

  • public byte[] AuthenticationPayload

    What a client sends to be let in. Opaque to the session.

  • public int MaxAuthenticationPayloadBytes

    The most bytes a client's authentication payload may be.

  • public int BytesPerSecondPerPlayer

    What one peer's own messages may cost, in bytes a second. Zero is no budget at all.

  • public int BurstBytes

    How much of the budget may be saved up and spent at once.

  • public double ReservedFraction

    How much of the bucket only important messages may spend.

  • public int ReservedPriority

    The priority a message needs before it may spend the reserve.

  • public NetworkSimulationSettings? Simulation

    A 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