gowebsocket

README

gowebsocket

Websocket server in Golang.

---

Status: Started.

---

Usage

go run examples/example.go

License

BSD 3-Clause: LICENSE.txt

Documentation

Overview

Package gowebsocket is a websocket library. Currently functional api - will improve and add OO alternative.

Index

• type CustomHandler
• type SocketHandler
• type WebServer
  • func NewWebServer() *WebServer
• type WebsocketServer
  • func NewWebsocketServer() *WebsocketServer
  • func (s *WebsocketServer) Add(route string, handlerFn CustomHandler)
  • func (s *WebsocketServer) Start()

Types

type CustomHandler

type CustomHandler func([]byte, func(string))

CustomHandler is an alias.

type SocketHandler

type SocketHandler func(*websocket.Conn)

SocketHandler is an alias.

type WebServer

type WebServer struct{}

WebServer is a simple html server, useful for serving a websocket client.

func NewWebServer

func NewWebServer() *WebServer

NewWebServer returns a new WebServer.

type WebsocketServer

type WebsocketServer struct{}

WebsocketServer is the main struct representing the websocket server.

func NewWebsocketServer

func NewWebsocketServer() *WebsocketServer

NewWebsocketServer returns a new WebsocketServer.

func (*WebsocketServer) Add

func (s *WebsocketServer) Add(route string, handlerFn CustomHandler)

Add adds a route and an associated handler function.

func (*WebsocketServer) Start

func (s *WebsocketServer) Start()

Start starts the server listening for the specified routes.