Improve and add comments

[safcm/safcm.git] / rpc / conn.go

diff --git a/rpc/conn.go b/rpc/conn.go
index c59bbd323272b50b150fa5d6671d61bdf022b800..9786941c7e808966a9a76841bfd6e03981f81ba6 100644 (file)
--- a/rpc/conn.go
+++ b/rpc/conn.go
@@ -32,8 +32,9 @@ type Conn struct {
        events   chan<- ConnEvent // same as Events, to publish events
        eventsWg sync.WaitGroup
 
-       debug  bool
-       remote string
+       debug     bool
+       sshRemote string
+       sshOpts   []string
 
        cmd  *exec.Cmd
        conn *safcm.GobConn
@@ -42,10 +43,10 @@ type Conn struct {
 type ConnEventType int
 
 const (
-       _ ConnEventType = iota
-       ConnEventStderr
-       ConnEventDebug
-       ConnEventUpload
+       _               ConnEventType = iota
+       ConnEventStderr               // stderr from spawned process
+       ConnEventDebug                // debug message
+       ConnEventUpload               // remote helper upload in progress
 )
 
 type ConnEvent struct {
@@ -54,7 +55,7 @@ type ConnEvent struct {
 }
 
 // NewConn creates a new connection. Events in the returned struct must be
-// regularly read or the connection will stall. This must be done before
+// regularly read or the connection will hang. This must be done before
 // DialSSH is called to open a connection.
 func NewConn(debug bool) *Conn {
        ch := make(chan ConnEvent)