Class ConnectionConfig

Namespace

RabbitMQ.Client

Assembly

RabbitMQ.Client.dll

The configuration of a connection.

public sealed class ConnectionConfig

Inheritance

object

ConnectionConfig

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Fields

AuthMechanisms

SASL auth mechanisms to use.

public readonly IEnumerable<IAuthMechanismFactory> AuthMechanisms

Field Value

IEnumerable<IAuthMechanismFactory>

ClientProperties

Dictionary of client properties to be sent to the server.

public readonly IDictionary<string, object?> ClientProperties

Field Value

IDictionary<string, object>

ClientProvidedName

Default client provided name to be used for connections.

public readonly string? ClientProvidedName

Field Value

string

ConsumerDispatchConcurrency

Set to a value greater than one to enable concurrent processing. For a concurrency greater than one IAsyncBasicConsumer will be offloaded to the worker thread pool so it is important to choose the value for the concurrency wisely to avoid thread pool overloading. IAsyncBasicConsumer can handle concurrency much more efficiently due to the non-blocking nature of the consumer.

public readonly ushort ConsumerDispatchConcurrency

Field Value

ushort

ContinuationTimeout

Amount of time protocol operations (e.g.

queue.declare

) are allowed to take before timing out.

public readonly TimeSpan ContinuationTimeout

Field Value

TimeSpan

CredentialsProvider

Default ICredentialsProvider implementation. If set, this overrides UserName / Password

public readonly ICredentialsProvider CredentialsProvider

Field Value

ICredentialsProvider

HandshakeContinuationTimeout

Amount of time protocol handshake operations are allowed to take before timing out.

public readonly TimeSpan HandshakeContinuationTimeout

Field Value

TimeSpan

HeartbeatInterval

Heartbeat timeout to use when negotiating with the server.

public readonly TimeSpan HeartbeatInterval

Field Value

TimeSpan

MaxChannelCount

Maximum channel number to ask for.

public readonly ushort MaxChannelCount

Field Value

ushort

MaxFrameSize

Frame-max parameter to ask for (in bytes).

public readonly uint MaxFrameSize

Field Value

uint

MaxInboundMessageBodySize

Maximum body size of a message (in bytes).

public readonly uint MaxInboundMessageBodySize

Field Value

uint

NetworkRecoveryInterval

Amount of time client will wait for before re-trying to recover connection.

public readonly TimeSpan NetworkRecoveryInterval

Field Value

TimeSpan

Password

Password to use when authenticating to the server.

public readonly string Password

Field Value

string

RequestedConnectionTimeout

Timeout setting for connection attempts.

public readonly TimeSpan RequestedConnectionTimeout

Field Value

TimeSpan

TopologyRecoveryEnabled

Set to false to make automatic connection recovery not recover topology (exchanges, queues, bindings, etc).

public readonly bool TopologyRecoveryEnabled

Field Value

bool

TopologyRecoveryExceptionHandler

Custom logic for handling topology recovery exceptions that match the specified filters.

public readonly TopologyRecoveryExceptionHandler TopologyRecoveryExceptionHandler

Field Value

TopologyRecoveryExceptionHandler

TopologyRecoveryFilter

Filter to include/exclude entities from topology recovery. Default filter includes all entities in topology recovery.

public readonly TopologyRecoveryFilter TopologyRecoveryFilter

Field Value

TopologyRecoveryFilter

UserName

Username to use when authenticating to the server.

public readonly string UserName

Field Value

string

VirtualHost

Virtual host to access during this connection.

public readonly string VirtualHost

Field Value

string