gowebsocket

README

gowebsocket

Websocket server wrapper

Getting started

Requirements

• Go 1.7+ earlier versions untested

Instructions

1. Get deps:

go get github.com/tectiv3/gowebsocket

1. Example:

package main

import (
	ws "github.com/tectiv3/gowebsocket"
	"log"
	"net/http"
	"os"
)

var (
	wsCh          ws.MessagesChannel
	wsServer      *ws.Server
)

func main() {
	http.Handle("/", http.FileServer(http.Dir("public")))

	wsServer = ws.NewWebsocket("/websocket")

	go func() {
		for {
			select {
			case incoming := <-wsServer.Messages:
				go answerMessage(incoming.Client, incoming.Msg)
			}
		}
	}()

	go wsServer.Listen()

	log.Println("Running webserver on port 8787")
	if err := http.ListenAndServe(":8787", nil); err != nil {
		Log.Error(err)
	}
}

func answerMessage(client *ws.Client, msg *ws.Message) {
	switch msg.Type {
	case "connect":
		client.Send(&ws.Message{Type: "success", Text: "connected"})
	}
}

Documentation

Index

• type Client
  • func NewClient(conn Connection, server *Server) *Client
  • func (c *Client) Done()
  • func (c *Client) Listen()
  • func (c *Client) Send(msg *Message)
• type ClientMessage
• type Connection
• type Message
• type MessagesChannel
• type Server
  • func NewWebsocket(pattern string) *Server
  • func (s *Server) Add(c *Client)
  • func (s *Server) Clients() map[int]*Client
  • func (s *Server) Del(c *Client)
  • func (s *Server) Done()
  • func (s *Server) Err(err error)
  • func (s *Server) Listen()
  • func (s *Server) SendAll(msg *Message)
• type WebsocketConnection
  • func (c *WebsocketConnection) ReadMessage() (Message, error)
  • func (c *WebsocketConnection) WriteMessage(msg *Message) error

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(conn Connection, server *Server) *Client

func (*Client) Done

func (c *Client) Done()

func (*Client) Listen

func (c *Client) Listen()

Listen Write and Read request via chanel

func (*Client) Send

func (c *Client) Send(msg *Message)

type ClientMessage

type ClientMessage struct {
	Client *Client
	Msg    *Message
}

type Connection

type Connection interface {
	ReadMessage() (Message, error)
	WriteMessage(*Message) error
}

type Message

type Message struct {
	ID     int                    `json:"id,omitempty"`
	Text   string                 `json:"text,omitempty"`
	Type   string                 `json:"type"`
	Result interface{}            `json:"result,omitempty"`
	Params map[string]interface{} `json:"params,omitempty"`
}

type MessagesChannel

type MessagesChannel <-chan *ClientMessage

type Server

type Server struct {
	Messages chan *ClientMessage
	// contains filtered or unexported fields
}

func NewWebsocket

func NewWebsocket(pattern string) *Server

func (*Server) Add

func (s *Server) Add(c *Client)

func (*Server) Clients

func (s *Server) Clients() map[int]*Client

func (*Server) Del

func (s *Server) Del(c *Client)

func (*Server) Done

func (s *Server) Done()

func (*Server) Err

func (s *Server) Err(err error)

func (*Server) Listen

func (s *Server) Listen()

func (*Server) SendAll

func (s *Server) SendAll(msg *Message)

type WebsocketConnection

type WebsocketConnection struct {
	// contains filtered or unexported fields
}

func (*WebsocketConnection) ReadMessage

func (c *WebsocketConnection) ReadMessage() (Message, error)

func (*WebsocketConnection) WriteMessage

func (c *WebsocketConnection) WriteMessage(msg *Message) error