Index | Namespace RabbitMQ.Client

public class ConnectionParameters

Summary

Supplies values to ConnectionFactory for use in constructing IConnection instances.

Field Summary

Flags Type Name Summary
public const ushort DefaultChannelMax

Default value for the desired maximum number of channels, with zero meaning unlimited (value: 0)
public const uint DefaultFrameMax

Default value for the desired maximum frame size, with zero meaning unlimited (value: 0)
public const ushort DefaultHeartbeat

Default value for desired heartbeat interval, in seconds, with zero meaning none (value: 3)
public const string DefaultPass

Default password (value: "guest")
public const string DefaultUser

Default user name (value: "guest")
public const string DefaultVHost

Default virtual host (value: "/")

Property Summary

Flags Type Name Summary
public AccessRequestConfig AccessRequestConfig (rw)

Used to control whether Access.Request methods are sent to the peer or not, in conjunction with the protocol default.
public string Password (rw)

Password to use when authenticating to the server
public ushort RequestedChannelMax (rw)

Channel-max parameter to ask for (number of channels)
public uint RequestedFrameMax (rw)

Frame-max parameter to ask for (in bytes)
public ushort RequestedHeartbeat (rw)

Heartbeat setting to request (in seconds)
public string UserName (rw)

Username to use when authenticating to the server
public string VirtualHost (rw)

Virtual host to access during this connection

Constructor Summary

Flags Name Summary
public ConnectionParameters()

Construct a fresh instance, with all fields set to their respective defaults.

Method Summary

Flags Name Summary
public ConnectionParameters Clone()

Returns a fresh ConnectionParameters with the same values as this.

Field Detail

public const ushort DefaultChannelMax

Summary

Default value for the desired maximum number of channels, with zero meaning unlimited (value: 0)

public const uint DefaultFrameMax

Summary

Default value for the desired maximum frame size, with zero meaning unlimited (value: 0)

public const ushort DefaultHeartbeat

Summary

Default value for desired heartbeat interval, in seconds, with zero meaning none (value: 3)

public const string DefaultPass

Summary

Default password (value: "guest")

public const string DefaultUser

Summary

Default user name (value: "guest")

public const string DefaultVHost

Summary

Default virtual host (value: "/")

Property Detail

public AccessRequestConfig AccessRequestConfig (rw)

Summary

Used to control whether Access.Request methods are sent to the peer or not, in conjunction with the protocol default.

public string Password (rw)

Summary

Password to use when authenticating to the server

public ushort RequestedChannelMax (rw)

Summary

Channel-max parameter to ask for (number of channels)

public uint RequestedFrameMax (rw)

Summary

Frame-max parameter to ask for (in bytes)

public ushort RequestedHeartbeat (rw)

Summary

Heartbeat setting to request (in seconds)

public string UserName (rw)

Summary

Username to use when authenticating to the server

public string VirtualHost (rw)

Summary

Virtual host to access during this connection

Constructor Detail

ConnectionParameters

public ConnectionParameters()

Summary

Construct a fresh instance, with all fields set to their respective defaults.

Method Detail

Clone

public ConnectionParameters Clone()

Flags public
Return type ConnectionParameters

Summary

Returns a fresh ConnectionParameters with the same values as this.