chg: golint

Author: philippseith

clientproxy.go

@@ -1,5 +1,6 @@
 package signalr
 
+//ClientProxy allows the hub to send messages to one or more of its clients
 type ClientProxy interface {
 	Send(target string, args ...interface{})
 }

groupmanager.go

@@ -1,5 +1,6 @@
 package signalr
 
+//GroupManager manages the client groups of the hub
 type GroupManager interface {
 	AddToGroup(groupName string, connectionID string)
 	RemoveFromGroup(groupName string, connectionID string)

hub.go

@@ -1,27 +1,34 @@
 package signalr
 
+// HubInterface is a hubs interface
 type HubInterface interface {
 	Initialize(hubContext HubContext)
 	OnConnected(connectionID string)
 	OnDisconnected(connectionID string)
 }
 
+// Hub is a base class for hubs
 type Hub struct {
 	context HubContext
 }
 
+// Initialize initializes a hub with a HubContext
 func (h *Hub) Initialize(ctx HubContext) {
 	h.context = ctx
 }
 
+// Clients returns the clients of this hub
 func (h *Hub) Clients() HubClients {
 	return h.context.Clients()
 }
 
+// Groups returns the client groups of this hub
 func (h *Hub) Groups() GroupManager {
 	return h.context.Groups()
 }
 
+// OnConnected is called when the hub is connected
 func (h *Hub) OnConnected(string) {}
 
+//OnDisconnected is called when the hub is disconnected
 func (h *Hub) OnDisconnected(string) {}

hubclients.go

@@ -1,5 +1,6 @@
 package signalr
 
+//HubClients gives the hub access to various client groups
 type HubClients interface {
 	All() ClientProxy
 	Client(connectionID string) ClientProxy

hubconnection.go

@@ -6,6 +6,13 @@ import (
 	"sync/atomic"
 )
 
+//Connection describes a connection between signalR client and server
+type Connection interface {
+	io.Reader
+	io.Writer
+	ConnectionID() string
+}
+
 type hubConnection interface {
 	Start()
 	IsConnected() bool
@@ -18,12 +25,6 @@ type hubConnection interface {
 	Ping()
 }
 
-type Connection interface {
-	io.Reader
-	io.Writer
-	ConnectionId() string
-}
-
 func newHubConnection(connection Connection, protocol HubProtocol) hubConnection {
 	return &defaultHubConnection{
 		Protocol:   protocol,
@@ -57,7 +58,7 @@ func (c *defaultHubConnection) Close(error string) {
 }
 
 func (c *defaultHubConnection) GetConnectionID() string {
-	return c.Connection.ConnectionId()
+	return c.Connection.ConnectionID()
 }
 
 func (c *defaultHubConnection) SendInvocation(target string, args []interface{}) {
@@ -87,10 +88,10 @@ func (c *defaultHubConnection) Receive() (interface{}, error) {
 			// Partial message, need more data
 			// ReadMessage read data out of the buf, so its gone there: refill
 			buf.Write(data[:n])
-			if n, err = c.Connection.Read(data); err != nil {
-				return nil, err
-			} else {
+			if n, err = c.Connection.Read(data); err == nil {
 				buf.Write(data[:n])
+			} else {
+				return nil, err
 			}
 		} else {
 			return message, err

hubcontext.go

@@ -1,5 +1,6 @@
 package signalr
 
+//HubContext holds the clients and groups connected to the hub
 type HubContext interface {
 	Clients() HubClients
 	Groups() GroupManager

hublifetimemanager.go

@@ -2,6 +2,7 @@ package signalr
 
 import "sync"
 
+//HubLifetimeManager manages the lifetime of a hub
 type HubLifetimeManager interface {
 	OnConnected(conn hubConnection)
 	OnDisconnected(conn hubConnection)

jsonhubprotocol.go

@@ -7,7 +7,7 @@ import (
 	"io"
 )
 
-type JsonHubProtocol struct {
+type jsonHubProtocol struct {
 }
 
 // Protocol specific message for correct unmarshaling of Arguments
@@ -19,11 +19,11 @@ type jsonInvocationMessage struct {
 	StreamIds    []string          `json:"streamIds,omitempty"`
 }
 
-func (j *JsonHubProtocol) UnmarshalArgument(argument interface{}, value interface{}) error {
+func (j *jsonHubProtocol) UnmarshalArgument(argument interface{}, value interface{}) error {
 	return json.Unmarshal(argument.(json.RawMessage), value)
 }
 
-func (j *JsonHubProtocol) ReadMessage(buf *bytes.Buffer) (interface{}, bool, error) {
+func (j *jsonHubProtocol) ReadMessage(buf *bytes.Buffer) (interface{}, bool, error) {
 	data, err := parseTextMessageFormat(buf)
 	switch {
 	case err == io.EOF:
@@ -86,7 +86,7 @@ func parseTextMessageFormat(buf *bytes.Buffer) ([]byte, error) {
 	return data[0 : len(data)-1], err
 }
 
-func (j *JsonHubProtocol) WriteMessage(message interface{}, writer io.Writer) error {
+func (j *jsonHubProtocol) WriteMessage(message interface{}, writer io.Writer) error {
 
 	// TODO: Reduce the amount of copies
 

server.go

@@ -11,19 +11,19 @@ import (
 	"time"
 )
 
-type Server struct {
+type server struct {
 	hub               HubInterface
 	lifetimeManager   HubLifetimeManager
-	defaultHubClients defaultHubClients
+	defaultHubClients HubClients
 	groupManager      GroupManager
 }
 
-func NewServer(hub HubInterface) *Server {
+func newServer(hub HubInterface) *server {
 	lifetimeManager := defaultHubLifetimeManager{}
-	return &Server{
+	return &server{
 		hub:             hub,
 		lifetimeManager: &lifetimeManager,
-		defaultHubClients: defaultHubClients{
+		defaultHubClients: &defaultHubClients{
 			lifetimeManager: &lifetimeManager,
 			allCache:        allClientProxy{lifetimeManager: &lifetimeManager},
 		},
@@ -33,7 +33,7 @@ func NewServer(hub HubInterface) *Server {
 	}
 }
 
-func (s *Server) messageLoop(conn Connection) {
+func (s *server) messageLoop(conn Connection) {
 	if protocol, err := processHandshake(conn); err != nil {
 		fmt.Println(err)
 	} else {
@@ -65,7 +65,7 @@ func (s *Server) messageLoop(conn Connection) {
 						// argument build failed
 						hubConn.Completion(invocation.InvocationID, nil, err.Error())
 					} else if clientStreaming {
-						// let the receiving method run idependently
+						// let the receiving method run independently
 						go func() {
 							defer func() {
 								if err := recover(); err != nil {
@@ -124,10 +124,10 @@ type hubInfo struct {
 	methods         map[string]reflect.Value
 }
 
-func (s *Server) newHubInfo() *hubInfo {
+func (s *server) newHubInfo() *hubInfo {
 
 	s.hub.Initialize(&defaultHubContext{
-		clients: &s.defaultHubClients,
+		clients: s.defaultHubClients,
 		groups:  s.groupManager,
 	})
 
@@ -286,7 +286,7 @@ func processHandshake(conn Connection) (HubProtocol, error) {
 }
 
 var protocolMap = map[string]HubProtocol{
-	"json": &JsonHubProtocol{},
+	"json": &jsonHubProtocol{},
 }
 
 type availableTransport struct {

signalr_suite_test.go

@@ -13,7 +13,7 @@ func TestSignalr(t *testing.T) {
 }
 
 func connect(hubProto HubInterface) *testingConnection {
-	server := NewServer(hubProto)
+	server := newServer(hubProto)
 	conn := newTestingConnection()
 	go server.messageLoop(conn)
 	return conn

testingconnection_test.go

@@ -14,7 +14,7 @@ type testingConnection struct {
 	received  chan interface{}
 }
 
-func (t *testingConnection) ConnectionId() string {
+func (t *testingConnection) ConnectionID() string {
 	return "test"
 }
 
@@ -75,10 +75,10 @@ func (t *testingConnection) clientReceive() (string, error) {
 	for {
 		if message, err := buf.ReadString(30); err != nil {
 			buf.Write(data[:n])
-			if n, err = t.cliReader.Read(data); err != nil {
-				return "", err
-			} else {
+			if n, err = t.cliReader.Read(data); err == nil {
 				buf.Write(data[:n])
+			} else{
+				return "", err
 			}
 		} else {
 			return message[:len(message)-1], nil

websocketServer.go

@@ -12,7 +12,7 @@ import (
 // MapHub used to register a SignalR Hub with the specified ServeMux
 func MapHub(mux *http.ServeMux, path string, hub HubInterface) {
 	mux.HandleFunc(fmt.Sprintf("%s/negotiate", path), negotiateHandler)
-	server := NewServer(hub)
+	server := newServer(hub)
 	mux.Handle(path, websocket.Handler(func(ws *websocket.Conn) {
 		connectionID := ws.Request().URL.Query().Get("id")
 		if len(connectionID) == 0 {

websocketconnection.go

@@ -11,7 +11,7 @@ type webSocketConnection struct {
 	connectionID string
 }
 
-func (w *webSocketConnection) ConnectionId() string {
+func (w *webSocketConnection) ConnectionID() string {
 	return w.connectionID
 }
 
@@ -24,11 +24,9 @@ func (w *webSocketConnection) Read(p []byte) (n int, err error) {
 		var data []byte
 		if err = websocket.Message.Receive(w.ws, &data); err != nil {
 			return 0, err
-		} else {
-			w.r = bytes.NewReader(data)
-			return w.r.Read(p)
 		}
-	} else {
+		w.r = bytes.NewReader(data)
 		return w.r.Read(p)
 	}
+	return w.r.Read(p)
 }