Struct HSteamNetConnection

Wraps the Steamworks HSteamNetConnection handle, a uint.

Implements
Inherited Members
Namespace: Unity.Steamworks.Interop
Assembly: Unity.Steamworks.Interop.dll
Syntax
[Serializable]
public struct HSteamNetConnection : IEquatable<HSteamNetConnection>, IComparable<HSteamNetConnection>

Constructors

HSteamNetConnection(uint)

Initializes a new HSteamNetConnection from its underlying value.

Declaration
public HSteamNetConnection(uint value)
Parameters
Type Name Description
uint value

The underlying uint value.

Fields

Invalid

The value the SDK reserves to mean "no HSteamNetConnection".

Declaration
public static readonly HSteamNetConnection Invalid
Field Value
Type Description
HSteamNetConnection

m_HSteamNetConnection

The underlying uint value.

Declaration
public uint m_HSteamNetConnection
Field Value
Type Description
uint

Methods

CompareTo(HSteamNetConnection)

Orders this value against other by their underlying values.

Declaration
public int CompareTo(HSteamNetConnection other)
Parameters
Type Name Description
HSteamNetConnection other

The value to compare against.
Returns
Type Description
int

Negative, zero or positive as this value sorts before, with or after other.

Equals(object)

Returns true when other is a HSteamNetConnection with the same value.

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
object other

The object to compare against.
Returns
Type Description
bool

true when other is a HSteamNetConnection holding the same value.
Overrides

Equals(HSteamNetConnection)

Returns true when this value equals other.

Declaration
public bool Equals(HSteamNetConnection other)
Parameters
Type Name Description
HSteamNetConnection other

The value to compare against.
Returns
Type Description
bool

true when both hold the same underlying value.

GetHashCode()

Returns the hash code of the underlying value.

Declaration
public override int GetHashCode()
Returns
Type Description
int

The underlying value's hash code.
Overrides

ToString()

Returns the underlying value as a string.

Declaration
public override string ToString()
Returns
Type Description
string

The underlying value formatted by its own ToString.
Overrides

Operators

operator ==(HSteamNetConnection, HSteamNetConnection)

Returns true when both operands hold the same value.

Declaration
public static bool operator ==(HSteamNetConnection x, HSteamNetConnection y)
Parameters
Type Name Description
HSteamNetConnection x

The first value to compare.
HSteamNetConnection y

The second value to compare.
Returns
Type Description
bool

true when the two hold the same underlying value.

explicit operator HSteamNetConnection(uint)

Converts a uint to a HSteamNetConnection. Explicit, so two handle types cannot convert into each other through the type they share.

Declaration
public static explicit operator HSteamNetConnection(uint value)
Parameters
Type Name Description
uint value

The underlying uint value.
Returns
Type Description
HSteamNetConnection

A HSteamNetConnection holding value.

explicit operator uint(HSteamNetConnection)

Converts a HSteamNetConnection to its underlying uint.

Declaration
public static explicit operator uint(HSteamNetConnection that)
Parameters
Type Name Description
HSteamNetConnection that

The handle to unwrap.
Returns
Type Description
uint

The underlying uint value.

operator !=(HSteamNetConnection, HSteamNetConnection)

Returns true when the operands hold different values.

Declaration
public static bool operator !=(HSteamNetConnection x, HSteamNetConnection y)
Parameters
Type Name Description
HSteamNetConnection x

The first value to compare.
HSteamNetConnection y

The second value to compare.
Returns
Type Description
bool

true when the two hold different underlying values.

Implements