Class RelayOpenResult

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Supervisor reports the result of a relay open request.

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

Inheritance

object

RelayOpenResult

Implements

IMessage<RelayOpenResult>

IEquatable<RelayOpenResult>

IDeepCloneable<RelayOpenResult>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

RelayOpenResult()

public RelayOpenResult()

RelayOpenResult(RelayOpenResult)

public RelayOpenResult(RelayOpenResult other)

Parameters

other RelayOpenResult

Fields

ChannelIdFieldNumber

Field number for the "channel_id" field.

public const int ChannelIdFieldNumber = 1

Field Value

int

ErrorFieldNumber

Field number for the "error" field.

public const int ErrorFieldNumber = 3

Field Value

int

SuccessFieldNumber

Field number for the "success" field.

public const int SuccessFieldNumber = 2

Field Value

int

Properties

ChannelId

Channel identifier from the RelayOpen request.

public string ChannelId { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Error

Error message if success is false.

public string Error { get; set; }

Property Value

string

Parser

public static MessageParser<RelayOpenResult> Parser { get; }

Property Value

MessageParser<RelayOpenResult>

Success

True if the relay was successfully established.

public bool Success { get; set; }

Property Value

bool

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.

Clone()

Creates a deep clone of this object.

public RelayOpenResult Clone()

Returns

RelayOpenResult

A deep clone of this object.

Equals(RelayOpenResult)

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

public bool Equals(RelayOpenResult other)

Parameters

other RelayOpenResult

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(RelayOpenResult)

Merges the given message into this one.

public void MergeFrom(RelayOpenResult other)

Parameters

other RelayOpenResult

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.