Added comments to rcli

This commit is contained in:
Solomon Hykes 2013-02-12 08:42:15 -08:00
parent f330c2a248
commit abb7b81b13
2 changed files with 10 additions and 0 deletions

View File

@ -53,6 +53,9 @@ func ListenAndServe(proto, addr string, service Service) error {
return nil
}
// Parse an rcli call on a new connection, and pass it to `service` if it
// is valid.
func Serve(conn io.ReadWriter, service Service) error {
r := bufio.NewReader(conn)
var args []string

View File

@ -1,5 +1,12 @@
package rcli
// rcli (Remote Command-Line Interface) is a simple protocol for...
// serving command-line interfaces remotely.
//
// rcli can be used over any transport capable of a) sending binary streams in
// both directions, and b) capable of half-closing a connection. TCP and Unix sockets
// are the usual suspects.
import (
"fmt"
"io"