Class EndpointConfiguration

Namespace

Silverback.Messaging.Configuration

Assembly

Silverback.Integration.dll

The base class for ProducerEndpointConfiguration and ConsumerEndpointConfiguration.

public abstract record EndpointConfiguration : IEquatable<EndpointConfiguration>

Inheritance

object

EndpointConfiguration

Implements

IEquatable<EndpointConfiguration>

Derived

ConsumerEndpointConfiguration

ProducerEndpointConfiguration

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

EndpointConfiguration()

protected EndpointConfiguration()

EndpointConfiguration(EndpointConfiguration)

protected EndpointConfiguration(EndpointConfiguration original)

Parameters

original EndpointConfiguration

Properties

DisplayName

Gets the name to be displayed in the human-targeted output (e.g. logs, health checks result, etc.).

public virtual string DisplayName { get; }

Property Value

string

Remarks

The DisplayName is built joining the optional FriendlyName with the RawName.

EqualityContract

protected virtual Type EqualityContract { get; }

Property Value

Type

FriendlyName

Gets an optional friendly name to be used to identify the endpoint. This name can be used to filter or retrieve the endpoints and will also be included in the DisplayName, to be shown in the human-targeted output (e.g. logs, health checks result, etc.).

public virtual string? FriendlyName { get; init; }

Property Value

string

Remarks

The DisplayName is built joining the optional FriendlyName with the RawName.

MessageValidationMode

Gets the message validation mode. This option can be used to specify if the messages have to be validated and whether an exception must be thrown if the message is not valid. The default is LogWarning.

public virtual MessageValidationMode MessageValidationMode { get; init; }

Property Value

MessageValidationMode

RawName

Gets the raw endpoint name. This can be either the topic name for a static registration, the pattern used to create the actual endpoint name or simply a placeholder.

public virtual string RawName { get; protected init; }

Property Value

string

Remarks

The DisplayName is built joining the optional FriendlyName with the RawName.

Methods

Equals(EndpointConfiguration?)

public virtual bool Equals(EndpointConfiguration? other)

Parameters

other EndpointConfiguration

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

PrintMembers(StringBuilder)

protected virtual bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

Validate()

Validates the endpoint configuration and throws an BrokerConfigurationException if not valid.

public void Validate()

ValidateCore()

Validates the endpoint configuration and throws an BrokerConfigurationException if not valid.

protected virtual void ValidateCore()

Operators

operator ==(EndpointConfiguration?, EndpointConfiguration?)

public static bool operator ==(EndpointConfiguration? left, EndpointConfiguration? right)

Parameters

left EndpointConfiguration

right EndpointConfiguration

Returns

bool

operator !=(EndpointConfiguration?, EndpointConfiguration?)

public static bool operator !=(EndpointConfiguration? left, EndpointConfiguration? right)

Parameters

left EndpointConfiguration

right EndpointConfiguration

Returns

bool