Class ProtocolMessage

* A wrapper around the service message, the contents of service message should be signed by the sender to avoid tampering mid-transit.

Inheritance

System.Object

ProtocolMessage

Implements

Google.Protobuf.IMessage<ProtocolMessage>

Google.Protobuf.IMessage

System.IEquatable<ProtocolMessage>

Google.Protobuf.IDeepCloneable<ProtocolMessage>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Catalyst.Protocol.Wire

Assembly: Catalyst.Protocol.dll

Syntax

public sealed class ProtocolMessage : IMessage<ProtocolMessage>, IMessage, IEquatable<ProtocolMessage>, IDeepCloneable<ProtocolMessage>

Constructors

| Improve this Doc View Source

ProtocolMessage()

Declaration

public ProtocolMessage()

| Improve this Doc View Source

ProtocolMessage(ProtocolMessage)

Declaration

public ProtocolMessage(ProtocolMessage other)

Parameters

Type	Name	Description
ProtocolMessage	other

Fields

| Improve this Doc View Source

CorrelationIdFieldNumber

Field number for the "correlation_id" field.

Declaration

public const int CorrelationIdFieldNumber = 2

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

PeerIdFieldNumber

Field number for the "peer_id" field.

Declaration

public const int PeerIdFieldNumber = 1

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

SignatureFieldNumber

Field number for the "signature" field.

Declaration

public const int SignatureFieldNumber = 5

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

TypeUrlFieldNumber

Field number for the "type_url" field.

Declaration

public const int TypeUrlFieldNumber = 3

Field Value

Type	Description
System.Int32

| Improve this Doc View Source

ValueFieldNumber

Field number for the "value" field.

Declaration

public const int ValueFieldNumber = 4

Field Value

Type	Description
System.Int32

Properties

| Improve this Doc View Source

CorrelationId

is a 16 bytes guid used to match responses to their original requests

Declaration

public ByteString CorrelationId { get; set; }

Property Value

Type	Description
Google.Protobuf.ByteString

| Improve this Doc View Source

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
Google.Protobuf.Reflection.MessageDescriptor

| Improve this Doc View Source

Parser

Declaration

public static MessageParser<ProtocolMessage> Parser { get; }

Property Value

Type	Description
Google.Protobuf.MessageParser<ProtocolMessage>

| Improve this Doc View Source

PeerId

is the sender's peerId

Declaration

public PeerId PeerId { get; set; }

Property Value

Type	Description
PeerId

| Improve this Doc View Source

Signature

is the ed25519ph context signature

Declaration

public Signature Signature { get; set; }

Property Value

Type	Description
Signature

| Improve this Doc View Source

TypeUrl

is the shortened protocol name of the message type being encoded in the value field (cf Any from protobuf WellKnownTypes)

Declaration

public string TypeUrl { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

Value

is the actual value of the message being wrapped (cf Any from protobuf WellKnownTypes)

Declaration

public ByteString Value { get; set; }

Property Value

Type	Description
Google.Protobuf.ByteString

Methods

| Improve this Doc View Source

CalculateSize()

Declaration

public int CalculateSize()

Returns

Type	Description
System.Int32

| Improve this Doc View Source

Clone()

Declaration

public ProtocolMessage Clone()

Returns

Type	Description
ProtocolMessage

| Improve this Doc View Source

Equals(ProtocolMessage)

Declaration

public bool Equals(ProtocolMessage other)

Parameters

Type	Name	Description
ProtocolMessage	other

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
System.Object	other

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

| Improve this Doc View Source

MergeFrom(ProtocolMessage)

Declaration

public void MergeFrom(ProtocolMessage other)

Parameters

Type	Name	Description
ProtocolMessage	other

| Improve this Doc View Source

MergeFrom(CodedInputStream)

Declaration

public void MergeFrom(CodedInputStream input)

Parameters

Type	Name	Description
Google.Protobuf.CodedInputStream	input

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()

| Improve this Doc View Source

WriteTo(CodedOutputStream)

Declaration

public void WriteTo(CodedOutputStream output)

Parameters

Type	Name	Description
Google.Protobuf.CodedOutputStream	output

Explicit Interface Implementations

| Improve this Doc View Source

IMessage.Descriptor

Declaration

MessageDescriptor IMessage.Descriptor { get; }

Returns

Type	Description
Google.Protobuf.Reflection.MessageDescriptor

Implements

Google.Protobuf.IMessage<T>

Google.Protobuf.IMessage

System.IEquatable<T>

Google.Protobuf.IDeepCloneable<T>