849 lines
38 KiB
XML
849 lines
38 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>GameCult.Mesh</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:GameCult.Mesh.CultMeshNodeOptions">
|
|
<summary>
|
|
Options for creating a local CultMesh node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNodeOptions.CacheOptions">
|
|
<summary>
|
|
Gets or sets the cache-open options used for the underlying CultCache.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNodeOptions.Security">
|
|
<summary>
|
|
Gets or sets the server security configuration. When omitted, development defaults are used.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNodeOptions.StartServer">
|
|
<summary>
|
|
Gets or sets whether the server should start immediately after creation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNodeOptions.DatabaseOptions">
|
|
<summary>
|
|
Gets or sets the mesh database sharding options used for the hosted CultCache.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNodeOptions.EnableDurableShardLogs">
|
|
<summary>
|
|
Gets or sets whether CultMesh should attach a file-backed authoritative shard-log store when none is supplied.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNodeOptions.ShardLogPath">
|
|
<summary>
|
|
Gets or sets the directory used for file-backed authoritative shard logs.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNodeOptions.DatabaseServerOptions">
|
|
<summary>
|
|
Gets or sets the database server bridge options used for shard routing and forwarding.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNodeOptions.ConfigureServer">
|
|
<summary>
|
|
Gets or sets an optional callback used to customize the server before start.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshNode">
|
|
<summary>
|
|
A locally hosted CultMesh node over CultCache, CultNet transport, and the mesh database facade.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNode.Cache">
|
|
<summary>
|
|
Gets the durable cache used by the node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNode.Store">
|
|
<summary>
|
|
Gets the canonical single-file MessagePack store, when one is attached.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNode.Server">
|
|
<summary>
|
|
Gets the underlying CultNet server.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNode.Database">
|
|
<summary>
|
|
Gets the distributed realtime database facade.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshNode.DatabaseServer">
|
|
<summary>
|
|
Gets the schema-v0 server bridge for distributed database messages.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshNode.Start">
|
|
<summary>
|
|
Starts the underlying server.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshNode.FlushAsync(System.Boolean)">
|
|
<summary>
|
|
Flushes the durable cache.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshNode.Dispose">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMesh">
|
|
<summary>
|
|
Public CultMesh entrypoints.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreateNodeAsync(System.String,GameCult.Mesh.CultMeshNodeOptions)">
|
|
<summary>
|
|
Creates a local CultMesh node with a durable CultCache and the canonical MessagePack backing store.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.StartNodeAsync(System.String,GameCult.Mesh.CultMeshNodeOptions)">
|
|
<summary>
|
|
Creates and starts a local CultMesh node with development-friendly defaults.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreateVerseCatalog">
|
|
<summary>
|
|
Creates a local reactive catalog for discovered Verses.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreatePeerCatalog">
|
|
<summary>
|
|
Creates a local reactive catalog for discovered peers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreateAuthorityLeaseCatalog">
|
|
<summary>
|
|
Creates a local authority lease catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreateStreamCatalog">
|
|
<summary>
|
|
Creates a local stream catalog for zero-copy-oriented audio, video, tensor, and byte frame streams.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreateSimulationFactCommitter(GameCult.Networking.CultNetDatabase)">
|
|
<summary>
|
|
Creates a committer for writing quorum simulation facts to a mesh database.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreateGameSession(GameCult.Mesh.CultMeshNode,GameCult.Mesh.CultMeshGameSessionOptions)">
|
|
<summary>
|
|
Creates a gameplay-facing session facade over a CultMesh node.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.ServeVerseCatalog(GameCult.Mesh.CultMeshNode,GameCult.Mesh.CultMeshVerseCatalog)">
|
|
<summary>
|
|
Attaches Verse discovery responses to a CultMesh node.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreateVerseDiscoveryClient(GameCult.Mesh.CultMeshVerseDiscoveryClientOptions)">
|
|
<summary>
|
|
Creates a client for fetching Verse catalogs from discovery endpoints.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.ServePeerExchange(GameCult.Mesh.CultMeshNode,GameCult.Mesh.CultMeshPeerCatalog)">
|
|
<summary>
|
|
Attaches peer exchange responses to a CultMesh node.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreatePeerExchangeClient(GameCult.Mesh.CultMeshPeerExchangeClientOptions)">
|
|
<summary>
|
|
Creates a client for fetching peer cards from peer exchange endpoints.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.CreateClient(GameCult.Networking.ClientSecurityOptions,System.Action{GameCult.Networking.Client})">
|
|
<summary>
|
|
Creates a CultNet client configured for CultMesh use.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMesh.ConnectClient(System.String,System.Int32,GameCult.Networking.ClientSecurityOptions,System.Action{GameCult.Networking.Client})">
|
|
<summary>
|
|
Creates and connects a CultNet client to a CultMesh node.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshAuthorityLease">
|
|
<summary>
|
|
Grants one peer authority to perform roles for a Verse over a bounded interval.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshAuthorityLease.#ctor(System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.DateTimeOffset,System.DateTimeOffset,System.String)">
|
|
<summary>
|
|
Creates an authority lease.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLease.LeaseId">
|
|
<summary>Gets the stable lease id.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLease.VerseId">
|
|
<summary>Gets the Verse id governed by the lease.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLease.PeerId">
|
|
<summary>Gets the peer id receiving authority.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLease.Roles">
|
|
<summary>Gets the roles granted by this lease.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLease.ShardIds">
|
|
<summary>Gets shard ids covered by this lease. Empty means every shard in the Verse.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLease.IssuerRuntimeId">
|
|
<summary>Gets the runtime that issued the lease.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLease.ValidFrom">
|
|
<summary>Gets the first timestamp when the lease is valid.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLease.ExpiresAt">
|
|
<summary>Gets the timestamp when the lease expires.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLease.Signature">
|
|
<summary>Gets an optional signature over the lease.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshAuthorityLease.IsValidAt(System.DateTimeOffset)">
|
|
<summary>
|
|
Returns whether this lease is valid at the supplied time.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshAuthorityLease.Covers(GameCult.Mesh.CultMeshPeerCard,System.String,System.String,System.Nullable{System.DateTimeOffset})">
|
|
<summary>
|
|
Returns whether this lease covers a peer card, role, and shard.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshAuthorityLeaseCatalog">
|
|
<summary>
|
|
Local authority lease catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshAuthorityLeaseCatalog.Leases">
|
|
<summary>Gets all known leases.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshAuthorityLeaseCatalog.Upsert(GameCult.Mesh.CultMeshAuthorityLease)">
|
|
<summary>Adds or replaces an authority lease.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshAuthorityLeaseCatalog.Get(System.String)">
|
|
<summary>Gets a lease by id, if known.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshAuthorityLeaseCatalog.IsAuthorized(GameCult.Mesh.CultMeshPeerCard,System.String,System.String,System.Nullable{System.DateTimeOffset})">
|
|
<summary>
|
|
Returns whether a peer card is authorized for a role and optional shard.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshGameSessionOptions">
|
|
<summary>
|
|
Options for creating a gameplay-facing CultMesh session facade.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSessionOptions.VerseCatalog">
|
|
<summary>
|
|
Gets or sets the Verse catalog used by the session.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSessionOptions.PeerCatalog">
|
|
<summary>
|
|
Gets or sets the peer catalog used by the session.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSessionOptions.AuthorityLeases">
|
|
<summary>
|
|
Gets or sets the authority lease catalog used by the session.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSessionOptions.ConsensusOptions">
|
|
<summary>
|
|
Gets or sets simulation consensus options.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSessionOptions.ServeSimulationObservations">
|
|
<summary>
|
|
Gets or sets whether incoming observation messages should update the session hub.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSessionOptions.ServeVerseDiscovery">
|
|
<summary>
|
|
Gets or sets whether the node should answer Verse catalog requests from the session catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSessionOptions.ServePeerExchange">
|
|
<summary>
|
|
Gets or sets whether the node should answer peer exchange requests from the session peer catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshGameSession">
|
|
<summary>
|
|
Gameplay-facing facade over common CultMesh runtime pieces.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshGameSession.#ctor(GameCult.Mesh.CultMeshNode,GameCult.Mesh.CultMeshGameSessionOptions)">
|
|
<summary>
|
|
Creates a game session facade.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSession.Node">
|
|
<summary>
|
|
Gets the underlying node.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSession.VerseCatalog">
|
|
<summary>
|
|
Gets the session Verse catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSession.PeerCatalog">
|
|
<summary>
|
|
Gets the session peer catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSession.AuthorityLeases">
|
|
<summary>
|
|
Gets the session authority lease catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSession.ObservationHub">
|
|
<summary>
|
|
Gets the session simulation observation hub.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshGameSession.FactCommitter">
|
|
<summary>
|
|
Gets the session simulation fact committer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshGameSession.WatchCandidates">
|
|
<summary>
|
|
Watches consensus candidate updates.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshGameSession.WatchSimulationFacts">
|
|
<summary>
|
|
Watches committed simulation facts.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshGameSession.PredictAsync``1(GameCult.Caching.CultRecordKey,``0)">
|
|
<summary>
|
|
Applies a local client prediction through the underlying database.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshGameSession.SubmitObservation(GameCult.Networking.CultNetSimulationObservation)">
|
|
<summary>
|
|
Submits one witness observation and returns the current candidates for that subject.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshGameSession.SubmitAndCommitAsync(GameCult.Networking.CultNetSimulationObservation)">
|
|
<summary>
|
|
Submits one witness observation and commits any new quorum facts it creates.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshGameSession.CommitQuorumCandidatesAsync(System.Collections.Generic.IEnumerable{GameCult.Networking.CultNetSimulationConsensusCandidate})">
|
|
<summary>
|
|
Commits quorum candidates that have not already been committed by this session.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshGameSession.Dispose">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshPeerRoles">
|
|
<summary>
|
|
Well-known CultMesh peer roles.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GameCult.Mesh.CultMeshPeerRoles.Discovery">
|
|
<summary>Peer can answer discovery requests.</summary>
|
|
</member>
|
|
<member name="F:GameCult.Mesh.CultMeshPeerRoles.ShardPrimary">
|
|
<summary>Peer can serve authoritative shard logs.</summary>
|
|
</member>
|
|
<member name="F:GameCult.Mesh.CultMeshPeerRoles.ShardReplica">
|
|
<summary>Peer can serve replicated shard logs.</summary>
|
|
</member>
|
|
<member name="F:GameCult.Mesh.CultMeshPeerRoles.ReadReplica">
|
|
<summary>Peer can serve read traffic.</summary>
|
|
</member>
|
|
<member name="F:GameCult.Mesh.CultMeshPeerRoles.SimulationObserver">
|
|
<summary>Peer can observe simulation facts.</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshPeerCard">
|
|
<summary>
|
|
Candidate peer contact information for a Verse.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerCard.#ctor(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,System.String)">
|
|
<summary>
|
|
Creates a peer card.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCard.PeerId">
|
|
<summary>Gets the stable peer id.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCard.VerseId">
|
|
<summary>Gets the Verse id this peer participates in.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCard.Endpoints">
|
|
<summary>Gets reachable endpoints.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCard.Roles">
|
|
<summary>Gets advertised roles.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCard.ShardIds">
|
|
<summary>Gets shard ids this peer can serve or observe.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCard.Region">
|
|
<summary>Gets an optional region/locality label.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCard.AuthorityLeaseId">
|
|
<summary>Gets the authority lease id, when present.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCard.ExpiresAt">
|
|
<summary>Gets the expiry timestamp for this card.</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCard.Signature">
|
|
<summary>Gets an optional signature over the card.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerCard.HasRole(System.String)">
|
|
<summary>
|
|
Returns whether the card advertises a role.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshPeerMessages">
|
|
<summary>
|
|
Conversion helpers for CultMesh peer exchange messages.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerMessages.ToMessage(GameCult.Mesh.CultMeshPeerCard)">
|
|
<summary>
|
|
Converts a peer card to its schema-v0 wire shape.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerMessages.ToPeerCard(GameCult.Networking.CultMeshPeerCardMessage)">
|
|
<summary>
|
|
Converts a wire peer card to the local public API shape.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshPeerCatalog">
|
|
<summary>
|
|
Reactive local catalog for discovered CultMesh peers.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerCatalog.Peers">
|
|
<summary>Gets all known peers.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerCatalog.Watch">
|
|
<summary>Watches peer card updates.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerCatalog.Upsert(GameCult.Mesh.CultMeshPeerCard)">
|
|
<summary>Adds or replaces a peer card.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerCatalog.Upsert(GameCult.Networking.CultMeshPeerExchangeResponseMessage)">
|
|
<summary>Adds or replaces peer cards from a wire response.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerCatalog.Find(System.String,System.String)">
|
|
<summary>Finds peers by Verse and optional role.</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerCatalog.Dispose">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshPeerExchangeServer">
|
|
<summary>
|
|
Answers CultMesh peer exchange requests from a local peer catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerExchangeServer.#ctor(GameCult.Networking.Server,GameCult.Mesh.CultMeshPeerCatalog)">
|
|
<summary>
|
|
Creates and attaches a peer exchange bridge.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerExchangeServer.CreateResponse(GameCult.Networking.CultMeshPeerExchangeRequestMessage)">
|
|
<summary>
|
|
Creates a peer exchange response for a request.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerExchangeServer.Dispose">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshPeerExchangeClientOptions">
|
|
<summary>
|
|
Options for schema-v0 CultMesh peer exchange clients.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerExchangeClientOptions.Security">
|
|
<summary>
|
|
Gets or sets client security options used to connect to peer exchange endpoints.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerExchangeClientOptions.ConnectTimeout">
|
|
<summary>
|
|
Gets or sets how long to wait for a connection before failing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerExchangeClientOptions.ResponseTimeout">
|
|
<summary>
|
|
Gets or sets how long to wait for a peer exchange response before failing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshPeerExchangeClientOptions.ConfigureClient">
|
|
<summary>
|
|
Gets or sets a callback used to customize each ephemeral exchange client.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshPeerExchangeClient">
|
|
<summary>
|
|
Fetches peer cards from CultMesh peers.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerExchangeClient.#ctor(GameCult.Mesh.CultMeshPeerExchangeClientOptions)">
|
|
<summary>
|
|
Creates a peer exchange client.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerExchangeClient.FetchAsync(System.String,GameCult.Networking.CultMeshPeerExchangeRequestMessage)">
|
|
<summary>
|
|
Fetches peer cards from one endpoint.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshPeerExchangeClient.DiscoverAsync(GameCult.Mesh.CultMeshPeerCatalog,System.Collections.Generic.IEnumerable{System.String},System.String,System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.Int32})">
|
|
<summary>
|
|
Fetches peer cards from endpoints and upserts every response into a local peer catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshSimulationFact">
|
|
<summary>
|
|
Committed simulation fact derived from witness consensus.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.FactId">
|
|
<summary>
|
|
Stable fact identifier.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.ShardId">
|
|
<summary>
|
|
Shard containing the simulation.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.ShardEpoch">
|
|
<summary>
|
|
Shard authority epoch observed by witnesses.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.Frame">
|
|
<summary>
|
|
Simulation frame or tick.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.SubjectId">
|
|
<summary>
|
|
Subject the fact is about.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.ClaimKind">
|
|
<summary>
|
|
Fact kind, such as hit, collision, or ownership.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.ClaimHash">
|
|
<summary>
|
|
Hash of the accepted claim.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.ClaimSummary">
|
|
<summary>
|
|
Optional readable or app-specific claim detail.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.WitnessCount">
|
|
<summary>
|
|
Number of distinct witnesses supporting the fact.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.SupportWeight">
|
|
<summary>
|
|
Supporting witness weight.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.TotalWeight">
|
|
<summary>
|
|
Total observed weight for the same subject/frame/kind.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.Confidence">
|
|
<summary>
|
|
Support divided by total observed weight.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshSimulationFact.CommittedAt">
|
|
<summary>
|
|
Commit timestamp.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshSimulationFact.CreateRecordKey(GameCult.Networking.CultNetSimulationConsensusCandidate)">
|
|
<summary>
|
|
Builds a deterministic record key for a simulation fact.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshSimulationFact.ComputeFactId(GameCult.Networking.CultNetSimulationConsensusCandidate)">
|
|
<summary>
|
|
Builds a stable fact id for a consensus candidate.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshSimulationFact.FromCandidate(GameCult.Networking.CultNetSimulationConsensusCandidate,System.String)">
|
|
<summary>
|
|
Creates a committed fact document from a quorum candidate.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshSimulationFactCommitter">
|
|
<summary>
|
|
Commits quorum simulation candidates into the CultMesh database.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshSimulationFactCommitter.#ctor(GameCult.Networking.CultNetDatabase)">
|
|
<summary>
|
|
Creates a simulation fact committer.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshSimulationFactCommitter.CommitAsync(GameCult.Networking.CultNetSimulationConsensusCandidate)">
|
|
<summary>
|
|
Commits a quorum candidate as a simulation fact document.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshVerseAuthorityModel">
|
|
<summary>
|
|
Describes how a CultMesh Verse makes authority decisions.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GameCult.Mesh.CultMeshVerseAuthorityModel.OperatorCluster">
|
|
<summary>
|
|
A known operator cluster is authoritative for committed world state.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GameCult.Mesh.CultMeshVerseAuthorityModel.FederatedCluster">
|
|
<summary>
|
|
Regional operators share authority for lower latency and availability.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GameCult.Mesh.CultMeshVerseAuthorityModel.PeerToPeer">
|
|
<summary>
|
|
Peers participate directly in authority decisions.
|
|
</summary>
|
|
</member>
|
|
<member name="F:GameCult.Mesh.CultMeshVerseAuthorityModel.SubscribedOverlay">
|
|
<summary>
|
|
The Verse follows another Verse and applies declared overlays.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshVerseCompatibility">
|
|
<summary>
|
|
Declares transport and rules compatibility for a Verse.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseCompatibility.#ctor(System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Creates compatibility metadata.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseCompatibility.TransportVersion">
|
|
<summary>
|
|
Gets the CultMesh/CultNet transport compatibility version.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseCompatibility.RulesHash">
|
|
<summary>
|
|
Gets the stable rules hash.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseCompatibility.CompatibleVerseIds">
|
|
<summary>
|
|
Gets Verse ids this Verse can transfer from or subscribe to.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseCompatibility.RequiredPluginIds">
|
|
<summary>
|
|
Gets plugin ids required to enter this Verse.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseCompatibility.OptionalPluginIds">
|
|
<summary>
|
|
Gets plugin ids supported but not required by this Verse.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshVerseDescriptor">
|
|
<summary>
|
|
Describes one CultMesh Verse: a rule-bearing consensus graph.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseDescriptor.#ctor(System.String,System.String,GameCult.Mesh.CultMeshVerseAuthorityModel,GameCult.Mesh.CultMeshVerseCompatibility,System.Collections.Generic.IEnumerable{System.String},System.Collections.Generic.IEnumerable{System.String},System.String,System.String)">
|
|
<summary>
|
|
Creates a Verse descriptor.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDescriptor.VerseId">
|
|
<summary>
|
|
Gets the stable Verse id.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDescriptor.DisplayName">
|
|
<summary>
|
|
Gets the human-facing Verse name.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDescriptor.AuthorityModel">
|
|
<summary>
|
|
Gets the authority model used by this Verse.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDescriptor.Compatibility">
|
|
<summary>
|
|
Gets compatibility metadata for transport, rules, and plugins.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDescriptor.DiscoveryEndpoints">
|
|
<summary>
|
|
Gets discovery endpoints for nodes serving this Verse.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDescriptor.AuthorityRuntimeIds">
|
|
<summary>
|
|
Gets known authoritative runtime ids, when authority is cluster-shaped.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDescriptor.ParentVerseId">
|
|
<summary>
|
|
Gets the parent Verse id for subscribed overlays or branches.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDescriptor.Description">
|
|
<summary>
|
|
Gets optional public description.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseDescriptor.CanTransferFrom(GameCult.Mesh.CultMeshVerseDescriptor)">
|
|
<summary>
|
|
Returns whether this Verse can accept transfer from another Verse.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseDescriptor.ComputeRulesHash(System.String[])">
|
|
<summary>
|
|
Computes a stable rules hash from ordered rules/plugin parts.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshVerseCatalog">
|
|
<summary>
|
|
Reactive local catalog for discovered CultMesh Verses.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseCatalog.Verses">
|
|
<summary>
|
|
Gets all known Verses.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseCatalog.Watch">
|
|
<summary>
|
|
Watches Verse discovery updates.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseCatalog.Upsert(GameCult.Mesh.CultMeshVerseDescriptor)">
|
|
<summary>
|
|
Adds or replaces a discovered Verse.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseCatalog.Upsert(GameCult.Networking.CultMeshVerseCatalogResponseMessage)">
|
|
<summary>
|
|
Adds or replaces Verses from a wire catalog response.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseCatalog.Get(System.String)">
|
|
<summary>
|
|
Gets a Verse by id, if known.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseCatalog.FindTransferTargets(GameCult.Mesh.CultMeshVerseDescriptor)">
|
|
<summary>
|
|
Gets known Verses that can accept transfer from the supplied source Verse.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseCatalog.Dispose">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshVerseMessages">
|
|
<summary>
|
|
Conversion helpers for CultMesh Verse wire messages.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseMessages.ToMessage(GameCult.Mesh.CultMeshVerseDescriptor)">
|
|
<summary>
|
|
Converts a local Verse descriptor to its schema-v0 wire shape.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseMessages.ToVerseDescriptor(GameCult.Networking.CultMeshVerseDescriptorMessage)">
|
|
<summary>
|
|
Converts a schema-v0 Verse descriptor to the local public API shape.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshVerseDiscoveryServer">
|
|
<summary>
|
|
Answers CultMesh Verse discovery requests from a local Verse catalog.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseDiscoveryServer.#ctor(GameCult.Networking.Server,GameCult.Mesh.CultMeshVerseCatalog)">
|
|
<summary>
|
|
Creates and attaches a Verse discovery bridge.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseDiscoveryServer.CreateResponse(GameCult.Networking.CultMeshVerseCatalogRequestMessage)">
|
|
<summary>
|
|
Creates a Verse catalog response for a request.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseDiscoveryServer.Dispose">
|
|
<inheritdoc />
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshVerseDiscoveryClientOptions">
|
|
<summary>
|
|
Options for schema-v0 CultMesh Verse discovery clients.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDiscoveryClientOptions.Security">
|
|
<summary>
|
|
Gets or sets client security options used to connect to discovery endpoints.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDiscoveryClientOptions.ConnectTimeout">
|
|
<summary>
|
|
Gets or sets how long to wait for a connection before failing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDiscoveryClientOptions.ResponseTimeout">
|
|
<summary>
|
|
Gets or sets how long to wait for a discovery response before failing.
|
|
</summary>
|
|
</member>
|
|
<member name="P:GameCult.Mesh.CultMeshVerseDiscoveryClientOptions.ConfigureClient">
|
|
<summary>
|
|
Gets or sets a callback used to customize each ephemeral discovery client.
|
|
</summary>
|
|
</member>
|
|
<member name="T:GameCult.Mesh.CultMeshVerseDiscoveryClient">
|
|
<summary>
|
|
Fetches CultMesh Verse catalogs from discovery endpoints.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseDiscoveryClient.#ctor(GameCult.Mesh.CultMeshVerseDiscoveryClientOptions)">
|
|
<summary>
|
|
Creates a Verse discovery client.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseDiscoveryClient.FetchAsync(System.String,GameCult.Networking.CultMeshVerseCatalogRequestMessage)">
|
|
<summary>
|
|
Fetches a Verse catalog response from one discovery endpoint.
|
|
</summary>
|
|
</member>
|
|
<member name="M:GameCult.Mesh.CultMeshVerseDiscoveryClient.DiscoverAsync(GameCult.Mesh.CultMeshVerseCatalog,System.Collections.Generic.IEnumerable{System.String},System.String)">
|
|
<summary>
|
|
Fetches Verse catalogs from endpoints and upserts every response into a local catalog.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|