Class ControlMessage

Namespace

Microsoft.AutoGen.Protobuf

Assembly

Microsoft.AutoGen.Core.Grpc.dll

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

Inheritance

object

ControlMessage

Implements

IMessage<ControlMessage>

IEquatable<ControlMessage>

IDeepCloneable<ControlMessage>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ControlMessage()

public ControlMessage()

ControlMessage(ControlMessage)

public ControlMessage(ControlMessage other)

Parameters

other ControlMessage

Fields

DestinationFieldNumber

Field number for the "destination" field.

public const int DestinationFieldNumber = 2

Field Value

int

RespondToFieldNumber

Field number for the "respond_to" field.

public const int RespondToFieldNumber = 3

Field Value

int

RpcIdFieldNumber

Field number for the "rpc_id" field.

public const int RpcIdFieldNumber = 1

Field Value

int

RpcMessageFieldNumber

Field number for the "rpcMessage" field.

public const int RpcMessageFieldNumber = 4

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Destination

This is either: agentid=AGENT_ID clientid=CLIENT_ID

public string Destination { get; set; }

Property Value

string

HasRespondTo

Gets whether the "respond_to" field is set

public bool HasRespondTo { get; }

Property Value

bool

Parser

public static MessageParser<ControlMessage> Parser { get; }

Property Value

MessageParser<ControlMessage>

RespondTo

This is either: agentid=AGENT_ID clientid=CLIENT_ID Empty string means the message is a response

public string RespondTo { get; set; }

Property Value

string

RpcId

A response message should have the same id as the request message

public string RpcId { get; set; }

Property Value

string

RpcMessage

One of: SaveStateRequest saveStateRequest = 2; SaveStateResponse saveStateResponse = 3; LoadStateRequest loadStateRequest = 4; LoadStateResponse loadStateResponse = 5;

public Any RpcMessage { get; set; }

Property Value

Any

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.

ClearRespondTo()

Clears the value of the "respond_to" field

public void ClearRespondTo()

Clone()

Creates a deep clone of this object.

public ControlMessage Clone()

Returns

ControlMessage

A deep clone of this object.

Equals(ControlMessage)

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

public bool Equals(ControlMessage other)

Parameters

other ControlMessage

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

Merges the given message into this one.

public void MergeFrom(ControlMessage other)

Parameters

other ControlMessage

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.