Browse Source

Add docstring to pubsub.Publisher

Signed-off-by: Alexander Morozov <lk4d4@docker.com>
Alexander Morozov 10 years ago
parent
commit
7080f5d1cf
1 changed files with 2 additions and 0 deletions
  1. 2 0
      pkg/pubsub/publisher.go

+ 2 - 0
pkg/pubsub/publisher.go

@@ -19,6 +19,8 @@ func NewPublisher(publishTimeout time.Duration, buffer int) *Publisher {
 
 type subscriber chan interface{}
 
+// Publisher is basic pub/sub structure. Allows to send events and subscribe
+// to them. Can be safely used from multiple goroutines.
 type Publisher struct {
 	m           sync.RWMutex
 	buffer      int