RabbitMQConfig

io.github.positionpal.connection.AmqpConfiguration.RabbitMQConfig

case class RabbitMQConfig(host: String, port: Int, virtualHost: String, username: String, password: String, ssl: Boolean)

Configuration settings for connecting to a RabbitMQ server.

Value parameters

host: The hostname of the RabbitMQ server. Must be a valid hostname.
password: The password for authentication. Must contain printable ASCII characters only and be up to 255 characters long.
port: The port number of the RabbitMQ server. Must be in the range 0 to 65535.
ssl: Whether to use SSL for the connection. Defaults to false.
username: The username for authentication. Must be between 3 and 30 characters and can contain alphanumeric characters, dots, underscores, and hyphens.
virtualHost: The virtual host to connect to. Defaults to an empty string. If set, must be a valid virtual host name.

Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Extension method from AmqpConfiguration

Converts the RabbitMQ configuration into a URI string suitable for connection.

Returns: A URI string of the format: amqp[s]://username:password@host:port[/encodedVirtualHost]. The scheme will be amqps if SSL is enabled, otherwise amqp. The virtual host will be URL-encoded if specified and not /.

In this article

Generated with