Byn.Awrtc.ConnectionId Struct Reference

Connection id identifies one specific endpoint in a IBaseNetwork. More...

Public Member Functions
	ConnectionId (short lId)
	Creates a new id. Only for internal use.
override bool	Equals (object obj)
	Checks if the ids are equal.
bool	IsValid ()
	Returns true if the id has a valid value.
override int	GetHashCode ()
	Forwarded to the same version in the short id.
override string	ToString ()
	Forwarded to the same version in the short id.

Static Public Member Functions
static bool	operator== (ConnectionId i1, ConnectionId i2)
	Forwarded to the same version in the short id.
static bool	operator!= (ConnectionId i1, ConnectionId i2)
	Forwarded to the same version in the short id.
static bool	operator< (ConnectionId i1, ConnectionId i2)
	Forwarded to the same version in the short id.
static bool	operator> (ConnectionId i1, ConnectionId i2)
	Forwarded to the same version in the short id.
static bool	operator<= (ConnectionId i1, ConnectionId i2)
	Forwarded to the same version in the short id.
static bool	operator>= (ConnectionId i1, ConnectionId i2)
	Forwarded to the same version in the short id.

Public Attributes
short	id
	Stores the id as a short.

Static Public Attributes
static readonly ConnectionId	INVALID = new ConnectionId() { id = -1 }
	Specific id that is used to represent an invalid id.

Detailed Description

Connection id identifies one specific endpoint in a IBaseNetwork.

The id is only unique locally for a specific IBaseNetwork. The same connection can have a different id on the other end point of the connection!

Constructor & Destructor Documentation

ConnectionId()

Byn.Awrtc.ConnectionId.ConnectionId

(

short

lId

)

Creates a new id. Only for internal use.

Parameters

lId

Member Function Documentation

Equals()

override bool Byn.Awrtc.ConnectionId.Equals

(

object

obj

)

Checks if the ids are equal.

Parameters

obj

Returns

GetHashCode()

override int Byn.Awrtc.ConnectionId.GetHashCode

(

)

Forwarded to the same version in the short id.

Returns

IsValid()

bool Byn.Awrtc.ConnectionId.IsValid

(

)

Returns true if the id has a valid value.

Returns

operator!=()

static bool Byn.Awrtc.ConnectionId.operator!= ( ConnectionId i1, ConnectionId i2 )

static

Forwarded to the same version in the short id.

Returns

operator<()

static bool Byn.Awrtc.ConnectionId.operator< ( ConnectionId i1, ConnectionId i2 )

static

Forwarded to the same version in the short id.

Returns

operator<=()

static bool Byn.Awrtc.ConnectionId.operator<= ( ConnectionId i1, ConnectionId i2 )

static

Forwarded to the same version in the short id.

Returns

operator==()

static bool Byn.Awrtc.ConnectionId.operator== ( ConnectionId i1, ConnectionId i2 )

static

Forwarded to the same version in the short id.

Returns

operator>()

static bool Byn.Awrtc.ConnectionId.operator> ( ConnectionId i1, ConnectionId i2 )

static

Forwarded to the same version in the short id.

Returns

operator>=()

static bool Byn.Awrtc.ConnectionId.operator>= ( ConnectionId i1, ConnectionId i2 )

static

Forwarded to the same version in the short id.

Returns

ToString()

override string Byn.Awrtc.ConnectionId.ToString

(

)

Forwarded to the same version in the short id.

Returns

Member Data Documentation

INVALID

readonly ConnectionId Byn.Awrtc.ConnectionId.INVALID = new ConnectionId() { id = -1 }

static

Specific id that is used to represent an invalid id.

Value might change to 0 in the future to make sure C# initializes empty id's to invalid values.

---

The documentation for this struct was generated from the following file:

• /Volumes/macdev/wrtc/main_new/awrtc/awrtc_cs_common/Byn.Awrtc/ConnectionId.cs