Class RelayOpen

Namespace

Openshell.V1

Assembly

OpenShell.Sdk.dll

Gateway requests the supervisor to open a relay channel.

On receiving this, the supervisor should initiate a RelayStream RPC to the gateway, sending a RelayInit in the first RelayFrame to associate the new HTTP/2 stream with the pending relay slot. The supervisor bridges that stream to the requested local target.

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

Inheritance

object

RelayOpen

Implements

IMessage<RelayOpen>

IEquatable<RelayOpen>

IDeepCloneable<RelayOpen>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

RelayOpen()

public RelayOpen()

RelayOpen(RelayOpen)

public RelayOpen(RelayOpen other)

Parameters

other RelayOpen

Fields

ChannelIdFieldNumber

Field number for the "channel_id" field.

public const int ChannelIdFieldNumber = 1

Field Value

int

ServiceIdFieldNumber

Field number for the "service_id" field.

public const int ServiceIdFieldNumber = 5

Field Value

int

SshFieldNumber

Field number for the "ssh" field.

public const int SshFieldNumber = 2

Field Value

int

TcpFieldNumber

Field number for the "tcp" field.

public const int TcpFieldNumber = 3

Field Value

int

Properties

ChannelId

Gateway-allocated channel identifier (UUID).

public string ChannelId { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<RelayOpen> Parser { get; }

Property Value

MessageParser<RelayOpen>

ServiceId

Optional service identifier for audit/correlation.

public string ServiceId { get; set; }

Property Value

string

Ssh

public SshRelayTarget Ssh { get; set; }

Property Value

SshRelayTarget

TargetCase

public RelayOpen.TargetOneofCase TargetCase { get; }

Property Value

RelayOpen.TargetOneofCase

Tcp

public TcpRelayTarget Tcp { get; set; }

Property Value

TcpRelayTarget

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.

ClearTarget()

public void ClearTarget()

Clone()

Creates a deep clone of this object.

public RelayOpen Clone()

Returns

RelayOpen

A deep clone of this object.

Equals(RelayOpen)

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

public bool Equals(RelayOpen other)

Parameters

other RelayOpen

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

Merges the given message into this one.

public void MergeFrom(RelayOpen other)

Parameters

other RelayOpen

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.