Skip to content

Commit

Permalink
Updated changelog and doc (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
@m3talux
m3talux authored May 9, 2024
1 parent d204388 commit 3cca88d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 23 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# 1.1.0

- Allow setting a connection name ([PR](https://github.com/KardinalAI/gorabbit/pull/8))
- Allow configuring a custom marshaller ([PR](https://github.com/KardinalAI/gorabbit/pull/10))
- Allow setting autoDelete on queues ([PR](https://github.com/KardinalAI/gorabbit/pull/11))
48 changes: 25 additions & 23 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,20 +89,21 @@ parameter.

### Client options

| Property | Description | Default Value |
|---------------------|---------------------------------------------------------|---------------|
| Host | The hostname of the RabbitMQ server | 127.0.0.1 |
| Port | The port of the RabbitMQ server | 5672 |
| Username | The plain authentication username | guest |
| Password | The plain authentication password | guest |
| Vhost | The specific vhost to use when connection to CloudAMQP | |
| UseTLS | The flag that activates the use of TLS (amqps) | false |
| KeepAlive | The flag that activates retry and re-connect mechanisms | true |
| RetryDelay | The delay between each retry and re-connection | 3 seconds |
| MaxRetry | The max number of message retry if it failed to process | 5 |
| PublishingCacheTTL | The time to live for a failed publish when set in cache | 60 seconds |
| PublishingCacheSize | The max number of failed publish to add into cache | 128 |
| Mode | The mode defines whether logs are shown or not | Release |
| Property | Description | Default Value |
|---------------------|---------------------------------------------------------------|---------------|
| Host | The hostname of the RabbitMQ server | 127.0.0.1 |
| Port | The port of the RabbitMQ server | 5672 |
| Username | The plain authentication username | guest |
| Password | The plain authentication password | guest |
| Vhost | The specific vhost to use when connection to CloudAMQP | |
| UseTLS | The flag that activates the use of TLS (amqps) | false |
| KeepAlive | The flag that activates retry and re-connect mechanisms | true |
| RetryDelay | The delay between each retry and re-connection | 3 seconds |
| MaxRetry | The max number of message retry if it failed to process | 5 |
| PublishingCacheTTL | The time to live for a failed publish when set in cache | 60 seconds |
| PublishingCacheSize | The max number of failed publish to add into cache | 128 |
| Mode | The mode defines whether logs are shown or not | Release |
| Marshaller | The content type used for messages and how they're marshalled | JSON |

### Client with default options

Expand Down Expand Up @@ -304,15 +305,16 @@ parameter.

### Manager options

| Property | Description | Default Value |
|---------------------|---------------------------------------------------------|---------------|
| Host | The hostname of the RabbitMQ server | 127.0.0.1 |
| Port | The port of the RabbitMQ server | 5672 |
| Username | The plain authentication username | guest |
| Password | The plain authentication password | guest |
| Vhost | The specific vhost to use when connection to CloudAMQP | |
| UseTLS | The flag that activates the use of TLS (amqps) | false |
| Mode | The mode defines whether logs are shown or not | Release |
| Property | Description | Default Value |
|------------|---------------------------------------------------------------|---------------|
| Host | The hostname of the RabbitMQ server | 127.0.0.1 |
| Port | The port of the RabbitMQ server | 5672 |
| Username | The plain authentication username | guest |
| Password | The plain authentication password | guest |
| Vhost | The specific vhost to use when connection to CloudAMQP | |
| UseTLS | The flag that activates the use of TLS (amqps) | false |
| Mode | The mode defines whether logs are shown or not | Release |
| Marshaller | The content type used for messages and how they're marshalled | JSON |

### Manager with default options

Expand Down

0 comments on commit 3cca88d

Please sign in to comment.