Interface: AMQPClientOptionsObject
Describes the shape of an object used for connecting to an AMQP server.
Properties
| Property | Type | Description |
|---|---|---|
channelMax? | number | The maximum number of channels allowed. Defaults to 0 (unlimited). |
frameMax? | number | The size in bytes of the maximum frame allowed over the connection. 0 means no limit. Defaults to 4096. |
heartbeat? | number | The period of the connection heartbeat, in seconds. Defaults to 0 (disabled). See https://www.rabbitmq.com/docs/heartbeats |
hostname | string | The hostname of the server. |
name? | string | The name of the connection to show in the RabbitMQ management UI. Omitted by default. |
password? | string | The password to use for authentication. Defaults to "guest". |
port? | number | The port to connect to. Defaults to 5672 for "amqp" and 5671 for "amqps". |
protocol | "amqp" | "amqps" | The protocol to use. Either "amqp" or "amqps". |
username? | string | The username to use for authentication. Defaults to "guest". |
vhost? | string | The logically isolated namespace within the server. Defaults to "/". Remarks This value is URI encoded when passed to the server. |