From 95f3681db8b0d2fcfc00efcf55fa6b3836cd53c6 Mon Sep 17 00:00:00 2001 From: Sundog Date: Sat, 17 Apr 2021 09:35:29 -0700 Subject: [PATCH] add package comment to openconn --- openconn/openconn.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/openconn/openconn.go b/openconn/openconn.go index 301ed27..bf32e3d 100644 --- 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 (