From 6ea72a1657752dc99b923339f3ff22fed7627df6 Mon Sep 17 00:00:00 2001
From: Michael Baird <mbaird@umbel.com>
Date: Tue, 25 Apr 2017 17:20:26 -0500
Subject: [PATCH] added comments to http broadcaster

---
 httpbroadcast/messenger.go | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/httpbroadcast/messenger.go b/httpbroadcast/messenger.go
index ebd4b2e6a..566d39c22 100644
--- a/httpbroadcast/messenger.go
+++ b/httpbroadcast/messenger.go
@@ -62,11 +62,11 @@ func (h *HTTPBroadcaster) SendAsync(pb proto.Message) error {
 
 func (h *HTTPBroadcaster) nodes() ([]*pilosa.Node, error) {
 	if h.server == nil {
-		return nil, errors.New("HTTPBroadcaster has no reference to Server.")
+		return nil, errors.New("HTTPBroadcaster has no reference to Server")
 	}
 	nodeset, ok := h.server.Cluster.NodeSet.(*HTTPNodeSet)
 	if !ok {
-		return nil, errors.New("NodeSet cannot be caste to HTTPNodeSet.")
+		return nil, errors.New("NodeSet cannot be caste to HTTPNodeSet")
 	}
 	return nodeset.Nodes(), nil
 }
@@ -106,12 +106,14 @@ func (h *HTTPBroadcaster) sendNodeMessage(node *pilosa.Node, msg []byte) error {
 	return nil
 }
 
+// HTTPBroadcastReceiver a Broadcaster that broadcasts messages over HTTP using the Pilosa Server.
 type HTTPBroadcastReceiver struct {
 	port      string
 	handler   pilosa.BroadcastHandler
 	logOutput io.Writer
 }
 
+// NewHTTPBroadcastReceiver returns a new instance of HTTPBroadcastReceiver.
 func NewHTTPBroadcastReceiver(port string, logOutput io.Writer) *HTTPBroadcastReceiver {
 	return &HTTPBroadcastReceiver{
 		port:      port,
@@ -119,6 +121,7 @@ func NewHTTPBroadcastReceiver(port string, logOutput io.Writer) *HTTPBroadcastRe
 	}
 }
 
+// Start implements the BroadcastReceiver interface and starts listening for broadcast messages.
 func (rec *HTTPBroadcastReceiver) Start(b pilosa.BroadcastHandler) error {
 	rec.handler = b
 	go func() {
@@ -166,14 +169,17 @@ func NewHTTPNodeSet() *HTTPNodeSet {
 	return &HTTPNodeSet{}
 }
 
+// Nodes implements the NodeSet interface and returns a list of nodes in the cluster.
 func (h *HTTPNodeSet) Nodes() []*pilosa.Node {
 	return h.nodes
 }
 
+// Open implements the NodeSet interface to start network activity, but for a HTTPNodeSet it does nothing.
 func (h *HTTPNodeSet) Open() error {
 	return nil
 }
 
+// Join sets the NodeSet nodes to the slices of Nodes passed in.
 func (h *HTTPNodeSet) Join(nodes []*pilosa.Node) error {
 	h.nodes = nodes
 	return nil