ReceptionistFlow Class

Namespace: Improbable.Gdk.CoreSource

Represents the Receptionist connection flow.

Inheritance

Improbable.Gdk.Core.IConnectionFlow


Fields

ReceptionistHost Source
string ReceptionistHost

The IP address of the Receptionist to use when connecting.

ReceptionistPort Source
ushort ReceptionistPort

The port of the Receptionist to use when connecting.

WorkerId Source
string WorkerId

The worker ID to use for the worker connection that will be created when CreateAsync is called.


Constructors

ReceptionistFlow Source
ReceptionistFlow(string workerId, IConnectionFlowInitializer<ReceptionistFlow> initializer = null)

Initializes a new instance of the ReceptionistFlow class.

Parameters
  • string workerId : The worker ID to use for the worker connection.
  • IConnectionFlowInitializer<ReceptionistFlow> initializer : Optional. An initializer to seed the data required to connect via the Receptionist flow.


Methods

CreateAsync Source
async Task<Connection> CreateAsync(ConnectionParameters parameters, CancellationToken? token = null)

Creates a Connection asynchronously.

Returns:
A task that represents the asynchronous creation of the Connection object.

Parameters
  • ConnectionParameters parameters : The connection parameters to use for the connection.
  • CancellationToken? token : A cancellation token which should cancel the underlying connection attempt.

Updated about a year ago


ReceptionistFlow Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.