Class RelayFrame

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

A single frame on the RelayStream RPC.

The supervisor MUST send init as the first frame. All subsequent frames in either direction carry raw bytes in data.

public sealed class RelayFrame : IMessage<RelayFrame>, IEquatable<RelayFrame>, IDeepCloneable<RelayFrame>, IBufferMessage, IMessage

Inheritance

object

RelayFrame

Implements

IMessage<RelayFrame>

IEquatable<RelayFrame>

IDeepCloneable<RelayFrame>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

RelayFrame()

public RelayFrame()

RelayFrame(RelayFrame)

public RelayFrame(RelayFrame other)

Parameters

other RelayFrame

Fields

DataFieldNumber

Field number for the "data" field.

public const int DataFieldNumber = 2

Field Value

int

InitFieldNumber

Field number for the "init" field.

public const int InitFieldNumber = 1

Field Value

int

Properties

Data

public ByteString Data { get; set; }

Property Value

ByteString

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

HasData

Gets whether the "data" field is set

public bool HasData { get; }

Property Value

bool

Init

public RelayInit Init { get; set; }

Property Value

RelayInit

Parser

public static MessageParser<RelayFrame> Parser { get; }

Property Value

MessageParser<RelayFrame>

PayloadCase

public RelayFrame.PayloadOneofCase PayloadCase { get; }

Property Value

RelayFrame.PayloadOneofCase

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

ClearData()

Clears the value of the oneof if it's currently set to "data"

public void ClearData()

ClearPayload()

public void ClearPayload()

Clone()

Creates a deep clone of this object.

public RelayFrame Clone()

Returns

RelayFrame

A deep clone of this object.

Equals(RelayFrame)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(RelayFrame other)

Parameters

other RelayFrame

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(RelayFrame)

Merges the given message into this one.

public void MergeFrom(RelayFrame other)

Parameters

other RelayFrame

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.