From 5d250edb6b5f0ba73595f0fb7bb5536bb46a616f Mon Sep 17 00:00:00 2001 From: Marc Di Luzio Date: Sat, 30 May 2020 23:17:59 +0100 Subject: [PATCH] Update comments --- cmd/rove-server/router.go | 2 +- pkg/rove/rove.go | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/cmd/rove-server/router.go b/cmd/rove-server/router.go index 5e26886..adc39e0 100644 --- a/cmd/rove-server/router.go +++ b/cmd/rove-server/router.go @@ -8,8 +8,8 @@ import ( "github.com/mdiluz/rove/pkg/rove" ) +// NewRouter sets up the server mux func NewRouter() (router *mux.Router) { - // Create a new router router = mux.NewRouter().StrictSlash(true) // Set up the handlers diff --git a/pkg/rove/rove.go b/pkg/rove/rove.go index 5bdc42d..1f3c01f 100644 --- a/pkg/rove/rove.go +++ b/pkg/rove/rove.go @@ -7,10 +7,12 @@ import ( "net/url" ) +// Connection is the container for a simple connection to the server type Connection struct { host string } +// NewConnection sets up a new connection to a server host func NewConnection(host string) *Connection { return &Connection{ host: host, @@ -22,6 +24,7 @@ type ServerStatus struct { Ready bool `json:"ready"` } +// Status returns the current status of the server func (c *Connection) Status() (status ServerStatus, err error) { url := url.URL{ Scheme: "http",