Module: AMQ::Settings

Defined in:
lib/amq/settings.rb

Constant Summary collapse

AMQPS = 
"amqps".freeze

Class Method Summary collapse

Class Method Details

.configure(settings = nil) ⇒ Hash

Merges given configuration parameters with defaults and returns the result.

Parameters:

  • Configuration (Hash) —

    parameters to use.

  • settings (Hash) (defaults to: nil) —

    a customizable set of options

Options Hash (settings):

  • :host (String) — default: "127.0.0.1" —

    Hostname AMQ broker runs on.

  • :port (String) — default: 5672 —

    Port AMQ broker listens on.

  • :vhost (String) — default: "/" —

    Virtual host to use.

  • :user (String) — default: "guest" —

    Username to use for authentication.

  • :pass (String) — default: "guest" —

    Password to use for authentication.

  • :ssl (String) — default: false —

    Should be use TLS (SSL) for connection?

  • :frame_max (Fixnum) — default: 131072 —

    Maximum frame size to use. If broker cannot support frames this large, broker’s maximum value will be used instead.

  • :heartbeat (Integer) — default: nil —

    Heartbeat timeout value in seconds to negotiate with the server.

  • :connection_timeout (Integer) — default: nil —

    Time in milliseconds to wait while establishing a TCP connection to the server before giving up.

  • :channel_max (Fixnum) — default: nil —

    Maximum number of channels to permit on this connection.

  • :auth_mechanism (Array) — default: [] —

    SASL authentication mechanisms to consider when negotiating a mechanism with the server. This parameter can be specified multiple times to specify multiple mechanisms, e.g. ‘?auth_mechanism=plain&auth_mechanism=amqplain`.

  • :verify (Boolean) — default: false —

    Controls peer verification mode.

  • :fail_if_no_peer_cert (Boolean) — default: false —

    When set to true, TLS connection will be rejected if client fails to provide a certificate.

  • :cacertfile (String) — default: nil —

    Certificate Authority (CA) certificate file path.

  • :certfile (String) — default: nil —

    Server certificate file path.

  • :keyfile (String) — default: nil —

    Server private key file path.

  • :broker (String) — default: nil —

    Broker name (use if you intend to use broker-specific features).

Returns:

  • (Hash) —

    Merged configuration parameters.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/amq/settings.rb', line 68

def self.configure(settings = nil)
  case settings
  when Hash then
    if username = (settings.delete(:username) || settings.delete(:user))
      settings[:user] ||= username
    end

    if password = (settings.delete(:password) || settings.delete(:pass))
      settings[:pass] ||= password
    end


    self.default.merge(settings)
  when String then
    settings = self.parse_amqp_url(settings)
    self.default.merge(settings)
  when NilClass then
    self.default
  end
end

.default ⇒ Object

Default connection settings used by AMQ clients

See Also:

  • Client::Settings.configure


15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/amq/settings.rb', line 15

def self.default
  @default ||= {
    # TCP/IP connection parameters
    host: "127.0.0.1",
    port: AMQ::Protocol::DEFAULT_PORT,
    auth_mechanism: [],

    # authentication parameters
    user: "guest",
    pass: "guest",
    vhost: "/",

    # client connection parameters
    frame_max: (128 * 1024),
    heartbeat: nil,
    connection_timeout: nil,
    channel_max: nil,

    # ssl parameters
    ssl: false,
    verify: false,
    fail_if_no_peer_cert: false,
    cacertfile: nil,
    certfile: nil,
    keyfile: nil
  }
end

.parse_amqp_url(connection_string) ⇒ Hash

Parses AMQP connection URI and returns its components as a hash.

h2. vhost naming schemes

It is convenient to be able to specify the AMQP connection parameters as a URI string, and various “amqp” URI schemes exist. Unfortunately, there is no standard for these URIs, so while the schemes share the basic idea, they differ in some details. This implementation aims to encourage URIs that work as widely as possible.

The URI scheme should be “amqp”, or “amqps” if SSL is required.

The host, port, username and password are represented in the authority component of the URI in the same way as in http URIs.

The vhost is obtained from the first segment of the path, with the leading slash removed. The path should contain only a single segment (i.e, the only slash in it should be the leading one). If the vhost is to include slashes or other reserved URI characters, these should be percent-escaped.

Examples:

How vhost is parsed


AMQ::Settings.parse_amqp_url("amqp://dev.rabbitmq.com")            # => vhost is nil, so default (/) will be used
AMQ::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/")           # => vhost is an empty string
AMQ::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/%2Fvault")   # => vhost is /vault
AMQ::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/production") # => vhost is production
AMQ::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/a.b.c")      # => vhost is a.b.c
AMQ::Settings.parse_amqp_url("amqp://dev.rabbitmq.com/foo/bar")    # => ArgumentError

Parameters:

  • connection_string (String) —

    AMQP connection URI, à la JDBC connection string. For example: amqp://bus.megacorp.internal:5877.

Returns:

  • (Hash) —

    Connection parameters (:username, :password, :vhost, :host, :port, :ssl)

Raises:

  • (ArgumentError) —

    When connection URI schema is not amqp or amqps, or the path contains multiple segments



127
128
129
 
# File 'lib/amq/settings.rb', line 127

def self.parse_amqp_url(connection_string)
  AMQ::URI.parse(connection_string)
end