Class ConsumerEndpointConfiguration

The consumer configuration.

Inheritance
object
EndpointConfiguration
ConsumerEndpointConfiguration
KafkaConsumerEndpointConfiguration
MqttConsumerEndpointConfiguration
Inherited Members
Namespace: Silverback.Messaging.Configuration
Assembly: Silverback.Integration.dll
Syntax
public abstract record ConsumerEndpointConfiguration : EndpointConfiguration, IEquatable<EndpointConfiguration>, IEquatable<ConsumerEndpointConfiguration>

Constructors

ConsumerEndpointConfiguration()

The consumer configuration.

Declaration
protected ConsumerEndpointConfiguration()

ConsumerEndpointConfiguration(ConsumerEndpointConfiguration)

The consumer configuration.

Declaration
protected ConsumerEndpointConfiguration(ConsumerEndpointConfiguration original)
Parameters
Type Name Description
ConsumerEndpointConfiguration original

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.

Declaration
public BatchSettings? Batch { get; init; }
Property Value
Type Description
BatchSettings

Deserializer

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

Declaration
public IMessageDeserializer Deserializer { get; init; }
Property Value
Type Description
IMessageDeserializer

Encryption

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

Declaration
public IDecryptionSettings? Encryption { get; init; }
Property Value
Type Description
IDecryptionSettings

EqualityContract

The consumer configuration.

Declaration
protected override Type EqualityContract { get; }
Property Value
Type Description
Type
Overrides

ErrorPolicy

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

Declaration
public IErrorPolicy ErrorPolicy { get; init; }
Property Value
Type Description
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.

Declaration
public SequenceSettings Sequence { get; init; }
Property Value
Type Description
SequenceSettings

ThrowIfUnhandled

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

Declaration
public bool ThrowIfUnhandled { get; init; }
Property Value
Type Description
bool

Methods

Equals(ConsumerEndpointConfiguration?)

The consumer configuration.

Declaration
public virtual bool Equals(ConsumerEndpointConfiguration? other)
Parameters
Type Name Description
ConsumerEndpointConfiguration other
Returns
Type Description
bool

Equals(EndpointConfiguration?)

The consumer configuration.

Declaration
public override sealed bool Equals(EndpointConfiguration? other)
Parameters
Type Name Description
EndpointConfiguration other
Returns
Type Description
bool
Overrides

Equals(object?)

The consumer configuration.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

GetHashCode()

The consumer configuration.

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

PrintMembers(StringBuilder)

The consumer configuration.

Declaration
protected override bool PrintMembers(StringBuilder builder)
Parameters
Type Name Description
StringBuilder builder
Returns
Type Description
bool
Overrides

ToString()

The consumer configuration.

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

ValidateCore()

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

Declaration
protected override void ValidateCore()
Overrides

Operators

operator ==(ConsumerEndpointConfiguration?, ConsumerEndpointConfiguration?)

The consumer configuration.

Declaration
public static bool operator ==(ConsumerEndpointConfiguration? left, ConsumerEndpointConfiguration? right)
Parameters
Type Name Description
ConsumerEndpointConfiguration left
ConsumerEndpointConfiguration right
Returns
Type Description
bool

operator !=(ConsumerEndpointConfiguration?, ConsumerEndpointConfiguration?)

The consumer configuration.

Declaration
public static bool operator !=(ConsumerEndpointConfiguration? left, ConsumerEndpointConfiguration? right)
Parameters
Type Name Description
ConsumerEndpointConfiguration left
ConsumerEndpointConfiguration right
Returns
Type Description
bool

Implements