add comments

network/network.go

@@ -10,28 +10,32 @@ import (
 // is responsible for routing messages to the correct services.
 type Network interface {
 	options.Options
-	// Create starts the network
+	// Create starts the network and creates a new node
 	Create() (*Node, error)
 	// Name of the network
 	Name() string
-	// Connect to a node
+	// Connect to a node on the network
 	Connect(*Node) (Conn, error)
-	// Listen for connections
+	// Listen for connections for this node
 	Listen(*Node) (Listener, error)
 }
 
+// Node is a network node represented with id/address and
+// metadata which includes the network name, transport, etc
 type Node struct {
 	Id       string
 	Address  string
 	Metadata map[string]string
 }
 
+// A network node listener which can be used to receive messages
 type Listener interface {
 	Address() string
 	Close() error
 	Accept() (Conn, error)
 }
 
+// A connection from another node on the network
 type Conn interface {
 	// Unique id of the connection
 	Id() string
@@ -47,6 +51,7 @@ type Conn interface {
 	Local() string
 }
 
+// The message type sent over the network
 type Message struct {
 	Header map[string]string
 	Body   []byte