Struct FrameIdentifier

Namespace

AppleTvControlLibrary.Protocol

Assembly

AppleTvControlLibrary.dll

Identifies a pending exchange either by XID (regular OPACK messages) or by the FrameType that is expected in response (auth messages, which never have an XID since parallel authentication attempts are impossible).

public readonly struct FrameIdentifier : IEquatable<FrameIdentifier>

Implements

IEquatable<FrameIdentifier>

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Methods

Equals(FrameIdentifier)

Determines whether this instance equals another instance.

public bool Equals(FrameIdentifier other)

Parameters

other FrameIdentifier

The instance to compare.

Returns

bool

True if both instances have equal values; otherwise false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

FromFrameType(FrameType)

Creates a FrameIdentifier keyed by frame type.

public static FrameIdentifier FromFrameType(FrameType frameType)

Parameters

frameType FrameType

The frame type used for the exchange.

Returns

FrameIdentifier

A frame identifier keyed by the supplied frame type.

FromXid(int)

Creates a FrameIdentifier keyed by XID.

public static FrameIdentifier FromXid(int xid)

Parameters

xid int

The exchange identifier.

Returns

FrameIdentifier

A frame identifier keyed by the supplied exchange identifier.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

Operators

operator ==(FrameIdentifier, FrameIdentifier)

Determines whether two FrameIdentifier instances are equal.

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

Parameters

left FrameIdentifier

The first frame identifier to compare.

right FrameIdentifier

The second frame identifier to compare.

Returns

bool

True if both frame identifiers have the same exchange identifier and frame type; otherwise false.

operator !=(FrameIdentifier, FrameIdentifier)

Determines whether two FrameIdentifier instances are not equal.

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

Parameters

left FrameIdentifier

The first frame identifier to compare.

right FrameIdentifier

The second frame identifier to compare.

Returns

bool

True if the frame identifiers differ; otherwise false.