rabbitmq 1.0.0

class: RabbitMqConnection

[30:14] (extern: com.lehman.aussom.RabbitMqConnection) extends: object

Connection to a RabbitMQ server. Configure with one AMQP URI (amqp://user:pass@host:5672/vhost, or amqps://... for TLS) or with the piecewise setters; nothing touches the network until connect() is called. Configuration setters apply at connect() time, so call them first. The connection is long-lived and thread safe; channels opened from it are not. Use each channel from one thread only.

Methods

• RabbitMqConnection (string Uri = null)

  Creates a connection definition.

  • @p Uri is a string with the AMQP URI (optional - the piecewise setters work instead).

• newConnection (string Uri = null)

• setUri (string Uri)

  Sets the AMQP URI. Call before connect().

  • @p Uri is a string with the amqp:// or amqps:// URI.
  • @r this object

• setHost (string Host)

  Sets the broker host name. Default localhost. Call before connect().

  • @p Host is a string with the host name.
  • @r this object

• setPort (int Port)

  Sets the broker port. Default 5672 (5671 with TLS). Call before connect().

  • @p Port is an int with the port number.
  • @r this object

• setVirtualHost (string VHost)

  Sets the virtual host. Default "/". Call before connect().

  • @p VHost is a string with the virtual host.
  • @r this object

• setUser (string User, string Password = null)

  Sets credentials. Default guest/guest, which RabbitMQ itself only accepts from localhost. Call before connect().

  • @p User is a string with the user name.
  • @p Password is a string with the password (optional).
  • @r this object

• setConnectionName (string Name)

  Sets the client-provided connection name shown in the broker's management UI. Call before connect().

  • @p Name is a string with the connection name.
  • @r this object

• addAddress (string Host, int Port = null)

  Adds an endpoint to the address list. When addresses are set, connect() tries them in order - RabbitMQ's equivalent of a failover URL list. Call before connect().

  • @p Host is a string with the host name.
  • @p Port is an int with the port (optional, default per scheme).
  • @r this object

• setHeartbeat (int Seconds)

  Sets the requested heartbeat interval. Default 60. Call before connect().

  • @p Seconds is an int with the heartbeat interval in seconds.
  • @r this object

• setConnectionTimeoutMs (int Ms)

  Sets the TCP connect timeout. Call before connect().

  • @p Ms is an int with the timeout in milliseconds.
  • @r this object

• setAutomaticRecovery (bool On)

  Enables or disables automatic connection recovery: the client transparently reconnects and re-opens channels after a network failure. Default true. Call before connect().

  • @p On is a bool with true to enable recovery.
  • @r this object

• setTopologyRecovery (bool On)

  Enables or disables topology recovery: re-declaring queues, exchanges, bindings, and consumers after a reconnect. Default true. Call before connect().

  • @p On is a bool with true to enable topology recovery.
  • @r this object

• setNetworkRecoveryIntervalMs (int Ms)

  Sets the delay between automatic recovery attempts. Default 5000. Call before connect().

  • @p Ms is an int with the recovery interval in milliseconds.
  • @r this object

• setChannelMax (int Max)

  Sets the requested channel-max protocol limit. Rarely needed. Call before connect().

  • @p Max is an int with the channel limit.
  • @r this object

• setFrameMax (int Bytes)

  Sets the requested frame-max protocol limit. Rarely needed. Call before connect().

  • @p Bytes is an int with the frame limit in bytes.
  • @r this object

• setClientProperty (string Name, Value)

  Adds a client property sent to the broker at handshake and shown in the management UI. Call before connect().

  • @p Name is a string with the property name.
  • @p Value is the property value (string/int/double/bool).
  • @r this object

• useTls ()

  Enables TLS using the JVM's default truststore, with hostname verification. Call before connect().

  • @r this object

• useTlsNoVerify ()

  Dev-only: enables TLS without certificate verification, so self-signed certs are accepted. A warning is logged at connect time. Do not use in production. Call before connect().

  • @r this object

• connect ()

  Builds the factory from the stored configuration and opens the connection.

  • @r this object

• openChannel ()

  Opens a new channel on this connection. Use each channel from one thread only.

  • @r A new RabbitMqChannel object.

• isConnected ()

  Reports whether the connection is open.

  • @r A bool with true while connected.

• isOpen ()

  Alias of isConnected().

  • @r A bool with true while connected.

• isBlocked ()

  Reports whether the broker has blocked this connection because of a resource alarm. Publishing while blocked stalls.

  • @r A bool with true while blocked.

• getServerProperties ()

  Gets the broker-announced server properties (product, version, capabilities).

  • @r A map with the server properties.

• close (int TimeoutMs = null)

  Closes the connection and every channel created from it. Safe to call more than once.

  • @p TimeoutMs is an int bounding the orderly shutdown (optional, default waits indefinitely).
  • @r this object

• abort ()

  Forces the connection closed without waiting for protocol shutdown. Never errors. Safe to call more than once.

  • @r this object