add package comment to openconn

2021-04-17 09:35:29 -07:00 · 2021-04-17 09:35:29 -07:00 · 95f3681db8
commit 95f3681db8
parent b2cfe0f1ab
1 changed files with 5 additions and 0 deletions
--- a/openconn/openconn.go
+++ b/openconn/openconn.go
@ -1,3 +1,8 @@
+// openconn provides a basic context.Context object to be used with gaio.Watcher
+// the context carries two channels, InChan and OutChan, which are used by menuHandler
+// and doorHandler to read input from the remote connection
+// TODO: decide whether or not we'll actuallly need OutChan - possibly for maintaining
+// output writes in order and/or ensuring output is delivered exactly once
 package openconn

 import (