Class ConsumerEndpointConfiguration

Namespace

Silverback.Messaging.Configuration

Assembly

Silverback.Integration.dll

The consumer configuration.

public abstract record ConsumerEndpointConfiguration : EndpointConfiguration, IEquatable<EndpointConfiguration>, IEquatable<ConsumerEndpointConfiguration>

Inheritance

object

EndpointConfiguration

ConsumerEndpointConfiguration

Implements

IEquatable<EndpointConfiguration>

IEquatable<ConsumerEndpointConfiguration>

Derived

KafkaConsumerEndpointConfiguration

MqttConsumerEndpointConfiguration

Inherited Members

EndpointConfiguration.Validate()

EndpointConfiguration.FriendlyName

EndpointConfiguration.RawName

EndpointConfiguration.DisplayName

EndpointConfiguration.MessageValidationMode

object.GetType()

object.MemberwiseClone()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ConsumerEndpointConfiguration()

protected ConsumerEndpointConfiguration()

ConsumerEndpointConfiguration(ConsumerEndpointConfiguration)

protected ConsumerEndpointConfiguration(ConsumerEndpointConfiguration original)

Parameters

original ConsumerEndpointConfiguration

Properties

Batch

Gets the batch settings. Can be used to enable and setup batch processing. The default is null, which means that batch processing is disabled.

public BatchSettings? Batch { get; init; }

Property Value

BatchSettings

Deserializer

Gets the IMessageDeserializer to be used to deserialize the consumed messages. The default is the JsonMessageDeserializer<TMessage>.

public IMessageDeserializer Deserializer { get; init; }

Property Value

IMessageDeserializer

Encryption

Gets the encryption settings to be used to decrypt the encrypted messages. The default is null.

public IDecryptionSettings? Encryption { get; init; }

Property Value

IDecryptionSettings

EqualityContract

protected override Type EqualityContract { get; }

Property Value

Type

ErrorPolicy

Gets the error policy to be applied when an exception occurs during the processing of the consumed messages. The default is the StopConsumerErrorPolicy.

public IErrorPolicy ErrorPolicy { get; init; }

Property Value

IErrorPolicy

Sequence

Gets the sequence settings. A sequence is a set of related messages, like the chunks belonging to the same message or the messages in a dataset.

public SequenceSettings Sequence { get; init; }

Property Value

SequenceSettings

ThrowIfUnhandled

Gets a value indicating whether an exception must be thrown if no subscriber is handling the received message. The default is true.

public bool ThrowIfUnhandled { get; init; }

Property Value

bool

Methods

Equals(ConsumerEndpointConfiguration?)

public virtual bool Equals(ConsumerEndpointConfiguration? other)

Parameters

other ConsumerEndpointConfiguration

Returns

bool

Equals(EndpointConfiguration?)

public override sealed 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 override bool PrintMembers(StringBuilder builder)

Parameters

builder StringBuilder

Returns

bool

ToString()

public override string ToString()

Returns

string

ValidateCore()

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

protected override void ValidateCore()

Operators

operator ==(ConsumerEndpointConfiguration?, ConsumerEndpointConfiguration?)

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

Parameters

left ConsumerEndpointConfiguration

right ConsumerEndpointConfiguration

Returns

bool

operator !=(ConsumerEndpointConfiguration?, ConsumerEndpointConfiguration?)

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

Parameters

left ConsumerEndpointConfiguration

right ConsumerEndpointConfiguration

Returns

bool