Class RabbitConnectionConfig

The configuration used to connect with the RabbitMQ broker.

Inheritance

object

RabbitConnectionConfig

Implements

IEquatable<RabbitConnectionConfig>

IValidatableEndpointSettings

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Silverback.Messaging.Configuration.Rabbit

Assembly: Silverback.Integration.RabbitMQ.dll

Syntax

public sealed class RabbitConnectionConfig : IEquatable<RabbitConnectionConfig>, IValidatableEndpointSettings

Properties

AmqpUriSslProtocols

Gets or sets the AMQP URI SSL protocols.

Declaration

public SslProtocols? AmqpUriSslProtocols { get; set; }

Property Value

Type	Description
SslProtocols?

AutomaticRecoveryEnabled

Gets or sets a value indicating whether the automatic connection recovery is enabled. The default is true.

Declaration

public bool? AutomaticRecoveryEnabled { get; set; }

Property Value

Type	Description
bool?

ClientProperties

Gets or sets the dictionary of client properties to be sent to the server.

Declaration

public IDictionary<string, object> ClientProperties { get; set; }

Property Value

Type	Description
IDictionary<string, object>

ClientProvidedName

Gets or sets the default client provided name to be used for connections.

Declaration

public string? ClientProvidedName { get; set; }

Property Value

Type	Description
string

ContinuationTimeout

Gets or sets the amount of time the protocol operations (e.g.

queue.declare

) are allowed to take before timing out.

Declaration

public TimeSpan? ContinuationTimeout { get; set; }

Property Value

Type	Description
TimeSpan?

HandshakeContinuationTimeout

Gets or sets the amount of time protocol handshake operations are allowed to take before timing out.

Declaration

public TimeSpan? HandshakeContinuationTimeout { get; set; }

Property Value

Type	Description
TimeSpan?

HostName

Gets or sets the name of th e host to connect to.

Declaration

public string? HostName { get; set; }

Property Value

Type	Description
string

NetworkRecoveryInterval

Gets or sets the amount of time the client will wait for before re-trying to recover the connection.

Declaration

public TimeSpan? NetworkRecoveryInterval { get; set; }

Property Value

Type	Description
TimeSpan?

Password

Gets or sets the password to use when authenticating to the server.

Declaration

public string? Password { get; set; }

Property Value

Type	Description
string

Port

Gets or sets the port to connect on.

Declaration

public int? Port { get; set; }

Property Value

Type	Description
int?

RequestedChannelMax

Gets or sets the maximum channel number to ask for.

Declaration

public ushort? RequestedChannelMax { get; set; }

Property Value

Type	Description
ushort?

RequestedConnectionTimeout

Gets or sets the timeout setting for the connection attempts.

Declaration

public TimeSpan? RequestedConnectionTimeout { get; set; }

Property Value

Type	Description
TimeSpan?

RequestedFrameMax

Gets or sets the frame-max parameter to ask for (in bytes).

Declaration

public uint? RequestedFrameMax { get; set; }

Property Value

Type	Description
uint?

RequestedHeartbeat

Gets or sets the heartbeat timeout to use when negotiating with the server.

Declaration

public TimeSpan? RequestedHeartbeat { get; set; }

Property Value

Type	Description
TimeSpan?

SocketReadTimeout

Gets or sets the timeout setting for the socket read operations.

Declaration

public TimeSpan? SocketReadTimeout { get; set; }

Property Value

Type	Description
TimeSpan?

SocketWriteTimeout

Gets or sets the timeout setting for the socket write operations.

Declaration

public TimeSpan? SocketWriteTimeout { get; set; }

Property Value

Type	Description
TimeSpan?

Ssl

Gets or sets the SSL options setting.

Declaration

public RabbitSslOption Ssl { get; set; }

Property Value

Type	Description
RabbitSslOption

TopologyRecoveryEnabled

Gets or sets a value indicating whether the automatic connection recovery must recover recover also topology (exchanges, queues, bindings, etc). Defaults to true.

Declaration

public bool? TopologyRecoveryEnabled { get; set; }

Property Value

Type	Description
bool?

UseBackgroundThreadsForIO

Gets or sets a value indicating whether a background thread will be used for the I/O loop.

Declaration

public bool? UseBackgroundThreadsForIO { get; set; }

Property Value

Type	Description
bool?

UserName

Gets or sets the username to use when authenticating to the server.

Declaration

public string? UserName { get; set; }

Property Value

Type	Description
string

VirtualHost

Gets or sets the virtual host to access during this connection.

Declaration

public string? VirtualHost { get; set; }

Property Value

Type	Description
string

Methods

Equals(RabbitConnectionConfig?)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(RabbitConnectionConfig? other)

Parameters

Type	Name	Description
RabbitConnectionConfig	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

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

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

Validate()

Throws an EndpointConfigurationException if the current configuration is not valid.

Declaration

public void Validate()

Implements

IEquatable<T>

IValidatableEndpointSettings