Struct GameConnectionConfiguration

Holds the configuration for a game connection.

Implements

System.IEquatable<GameConnectionConfiguration>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Phoenix.Controls.GameConnection

Assembly: Phoenix.Controls.GameConnection.dll

Syntax

public readonly struct GameConnectionConfiguration : IEquatable<GameConnectionConfiguration>

Constructors

View Source

GameConnectionConfiguration(Nullable<Int32>, Nullable<Guid>, Nullable<Int64>)

Initializes a new instance of the GameConnectionConfiguration struct.

Declaration

public GameConnectionConfiguration(int? port = null, Guid? serverId = null, long? connectionTimeoutMs = null)

Parameters

Type	Name	Description
System.Nullable<System.Int32>	port	The port to use.
System.Nullable<System.Guid>	serverId	The guid representing the server id.
System.Nullable<System.Int64>	connectionTimeoutMs	The timeout for connection in milliseconds.

Properties

View Source

ConnectionTimeoutMs

Gets the timeout for connection in milliseconds.

Declaration

public readonly long? ConnectionTimeoutMs { get; }

Property Value

Type	Description
System.Nullable<System.Int64>

View Source

Default

Gets the default configuration for a game connection.

Declaration

public static readonly GameConnectionConfiguration Default { get; }

Property Value

Type	Description
GameConnectionConfiguration

View Source

Port

Gets the port to use for the game connection.

Declaration

public readonly int? Port { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

View Source

ServerId

Gets the guid representing the server id.

Declaration

public readonly Guid? ServerId { get; }

Property Value

Type	Description
System.Nullable<System.Guid>

Methods

View Source

Equals(GameConnectionConfiguration)

Declaration

public readonly bool Equals(GameConnectionConfiguration other)

Parameters

Type	Name	Description
GameConnectionConfiguration	other

Returns

Type	Description
System.Boolean

View Source

Equals(Object)

Declaration

public override readonly bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.ValueType.Equals(System.Object)

View Source

GetHashCode()

Declaration

public override readonly int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.ValueType.GetHashCode()

View Source

ToString()

Converts to the string representation of the struct.

Declaration

public override readonly string ToString()

Returns

Type	Description
System.String	The string representation of the struct.

Overrides

System.ValueType.ToString()

Operators

View Source

Equality(GameConnectionConfiguration, GameConnectionConfiguration)

Determines if an item is equal to another.

Declaration

public static bool operator ==(GameConnectionConfiguration left, GameConnectionConfiguration right)

Parameters

Type	Name	Description
GameConnectionConfiguration	left	The item to compare.
GameConnectionConfiguration	right	The other item.

Returns

Type	Description
System.Boolean	The comparison result.

View Source

Inequality(GameConnectionConfiguration, GameConnectionConfiguration)

Determines if an item is not equal to another.

Declaration

public static bool operator !=(GameConnectionConfiguration left, GameConnectionConfiguration right)

Parameters

Type	Name	Description
GameConnectionConfiguration	left	The item to compare.
GameConnectionConfiguration	right	The other item.

Returns

Type	Description
System.Boolean	The comparison result.

Implements

System.IEquatable<T>