Add a small note about consumer thread-safety

2014-10-28 18:14:43 -07:00 · 2014-10-28 18:14:43 -07:00 · 433b739e45
parent 6cbceead8b
commit 433b739e45
1 changed files with 2 additions and 0 deletions
--- a/lib/hermann/consumer.rb
+++ b/lib/hermann/consumer.rb
@ -7,6 +7,8 @@ else
 end

 module Hermann
+  # Hermann::Consumer provides a simple consumer API which is only safe to be
+  # executed in a single thread
  class Consumer
    attr_reader :topic, :brokers, :partition, :internal