Various stylistic and grammar fixes

[govpn.git] / src / cypherpunks.ru / govpn / client / client.go

diff --git a/src/cypherpunks.ru/govpn/client/client.go b/src/cypherpunks.ru/govpn/client/client.go
index 76635a88ec9a9e84e8b456e53943e4cc518a08da..a4c49079157da40428bc5d534f7989afd0dad1e5 100644 (file)
--- a/src/cypherpunks.ru/govpn/client/client.go
+++ b/src/cypherpunks.ru/govpn/client/client.go
@@ -1,3 +1,21 @@
+/*
+GoVPN -- simple secure free software virtual private network daemon
+Copyright (C) 2014-2017 Sergey Matveev <stargrave@stargrave.org>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
 package client
 
 import (
@@ -12,13 +30,17 @@ import (
        "cypherpunks.ru/govpn"
 )
 
-type Protocol uint8
+// Protocol is a GoVPN supported protocol: either UDP, TCP or both
+type Protocol int
 
 const (
+       // ProtocolUDP is UDP transport protocol
        ProtocolUDP Protocol = iota
+       // ProtocolTCP is TCP transport protocol
        ProtocolTCP
 )
 
+// Configuration holds GoVPN client configuration
 type Configuration struct {
        PrivateKey          *[ed25519.PrivateKeySize]byte
        Peer                *govpn.PeerConf
@@ -34,6 +56,7 @@ type Configuration struct {
        MTU                 int
 }
 
+// Validate returns an error if a configuration is invalid
 func (c *Configuration) Validate() error {
        if c.MTU > govpn.MTUMax {
                return fmt.Errorf("Invalid MTU %d, maximum allowable is %d", c.MTU, govpn.MTUMax)
@@ -51,6 +74,7 @@ func (c *Configuration) isProxy() bool {
        return len(c.ProxyAddress) > 0
 }
 
+// Client is a GoVPN client
 type Client struct {
        idsCache      *govpn.MACCache
        tap           *govpn.TAP
@@ -67,6 +91,7 @@ type Client struct {
        Error chan error
 }
 
+// MainCycle main loop of a connecting/connected client
 func (c *Client) MainCycle() {
        var err error
        c.tap, err = govpn.TAPListen(c.config.InterfaceName, c.config.MTU)
@@ -111,7 +136,7 @@ MainCycle:
                        if c.config.NoReconnect {
                                break MainCycle
                        }
-                       govpn.BothPrintf(`[sleep seconds="%d"]`, c.config.Peer.Timeout)
+                       govpn.BothPrintf(`[sleep seconds="%d"]`, c.config.Peer.Timeout/time.Second)
                        time.Sleep(c.config.Peer.Timeout)
                case <-c.rehandshaking:
                }
@@ -128,6 +153,8 @@ MainCycle:
        }
 }
 
+// NewClient returns a configured GoVPN client, to trigger connection
+// MainCycle must be executed.
 func NewClient(conf Configuration, verifier *govpn.Verifier, termSignal chan os.Signal) *Client {
        client := Client{
                idsCache:    govpn.NewMACCache(),
@@ -136,7 +163,7 @@ func NewClient(conf Configuration, verifier *govpn.Verifier, termSignal chan os.
                termSignal:  termSignal,
                Error:       make(chan error, 1),
        }
-       confs := map[govpn.PeerId]*govpn.PeerConf{*verifier.Id: conf.Peer}
+       confs := map[govpn.PeerID]*govpn.PeerConf{*verifier.ID: conf.Peer}
        client.idsCache.Update(&confs)
        return &client
 }