Class EnvelopeHttpMessage<TPayload>

Namespace

GroupeIsa.Neos.Shared.ClusterCommunication

Assembly

GroupeIsa.Neos.Shared.dll

Represents a envelop which contains payload for Http communication for Pipe communication.

public class EnvelopeHttpMessage<TPayload> : EnvelopeHttpMessageBase where TPayload : class

Type Parameters

TPayload

Payload type.

Inheritance

object

EnvelopeHttpMessageBase

EnvelopeHttpMessage<TPayload>

Inherited Members

EnvelopeHttpMessageBase.CorrelationId

EnvelopeHttpMessageBase.TenantIdentifier

EnvelopeHttpMessageBase.NeosUser

EnvelopeHttpMessageBase.ConnectionId

EnvelopeHttpMessageBase.ApplicationContext

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EnvelopeHttpMessage(string, string?, string?, string?, IDictionary<string, string>, TPayload?)

Initializes a new instance of the EnvelopeHttpMessage<TPayload> class.

public EnvelopeHttpMessage(string correlationId, string? tenantIdentifier, string? neosUser, string? connectionId, IDictionary<string, string> applicationContext, TPayload? payload)

Parameters

correlationId string

The correlation identifier for keep context in communication inter-cluster.

tenantIdentifier string

The tenant identifier.

neosUser string

The user information, like name and mail.

connectionId string

Connection id.

applicationContext IDictionary<string, string>

The application context.

payload TPayload

Payload to send.

Properties

Payload

Gets the payload.

public TPayload? Payload { get; }

Property Value

TPayload

Methods

Equals(object?)

Determines whether the specified object is equal to the current object.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current 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.

WithPayload(TPayload?)

Creates a new instance of EnvelopeHttpMessage<TPayload> with the specified payload.

public EnvelopeHttpMessage<TPayload> WithPayload(TPayload? payload)

Parameters

payload TPayload

Payload.

Returns

EnvelopeHttpMessage<TPayload>

The new instance.

WithPayload<TNewPayload>(TNewPayload?)

Creates a new instance of EnvelopeHttpMessage<TPayload> with the specified payload.

public EnvelopeHttpMessage<TNewPayload> WithPayload<TNewPayload>(TNewPayload? payload) where TNewPayload : class

Parameters

payload TNewPayload

Payload.

Returns

EnvelopeHttpMessage<TNewPayload>

The new instance.

Type Parameters

TNewPayload

New payload type.