Class SupervisorMessage

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Envelope for supervisor-to-gateway messages on the ConnectSupervisor stream.

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

Inheritance

object

SupervisorMessage

Implements

IMessage<SupervisorMessage>

IEquatable<SupervisorMessage>

IDeepCloneable<SupervisorMessage>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SupervisorMessage()

public SupervisorMessage()

SupervisorMessage(SupervisorMessage)

public SupervisorMessage(SupervisorMessage other)

Parameters

other SupervisorMessage

Fields

ConfigUpdateResultFieldNumber

Field number for the "config_update_result" field.

public const int ConfigUpdateResultFieldNumber = 5

Field Value

int

HeartbeatFieldNumber

Field number for the "heartbeat" field.

public const int HeartbeatFieldNumber = 2

Field Value

int

HelloFieldNumber

Field number for the "hello" field.

public const int HelloFieldNumber = 1

Field Value

int

RelayCloseFieldNumber

Field number for the "relay_close" field.

public const int RelayCloseFieldNumber = 4

Field Value

int

RelayOpenResultFieldNumber

Field number for the "relay_open_result" field.

public const int RelayOpenResultFieldNumber = 3

Field Value

int

Properties

ConfigUpdateResult

public ConfigUpdateResult ConfigUpdateResult { get; set; }

Property Value

ConfigUpdateResult

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Heartbeat

public SupervisorHeartbeat Heartbeat { get; set; }

Property Value

SupervisorHeartbeat

Hello

public SupervisorHello Hello { get; set; }

Property Value

SupervisorHello

Parser

public static MessageParser<SupervisorMessage> Parser { get; }

Property Value

MessageParser<SupervisorMessage>

PayloadCase

public SupervisorMessage.PayloadOneofCase PayloadCase { get; }

Property Value

SupervisorMessage.PayloadOneofCase

RelayClose

public RelayClose RelayClose { get; set; }

Property Value

RelayClose

RelayOpenResult

public RelayOpenResult RelayOpenResult { get; set; }

Property Value

RelayOpenResult

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.

ClearPayload()

public void ClearPayload()

Clone()

Creates a deep clone of this object.

public SupervisorMessage Clone()

Returns

SupervisorMessage

A deep clone of this object.

Equals(SupervisorMessage)

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

public bool Equals(SupervisorMessage other)

Parameters

other SupervisorMessage

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

Merges the given message into this one.

public void MergeFrom(SupervisorMessage other)

Parameters

other SupervisorMessage

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.