Skip to content

Commit 0899d6b

Browse files
author
Pascal de Vink
committed
Update README with notice about heartbeats
The original notice was added to the pull request that added heartbeat support, but it wasn't added to the documentation. This made it a rather annoying caveat.
1 parent 0834124 commit 0899d6b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,10 @@ configuration to avoid unnecessary connections to your message broker in every r
178178
It's extremely recommended to use lazy connections because performance reasons, nevertheless lazy option is disabled
179179
by default to avoid possible breaks in applications already using this bundle.
180180

181+
### Import notice - Heartbeats ###
182+
183+
It's a good idea to set the ```read_write_timeout``` to 2x the heartbeat so your socket will be open. If you don't do this, or use a different multiplier, there's a risk the __consumer__ socket will timeout.
184+
181185
## Producers, Consumers, What? ##
182186

183187
In a messaging application, the process sending messages to the broker is called __producer__ while the process receiving those messages is called __consumer__. In your application you will have several of them that you can list under their respective entries in the configuration.

0 commit comments

Comments
 (0)