conn

README

websocket-conn

📞 A dead simple WebSocket connection written in Go.

websocket-conn provides you with easy handling for WebSockets, it's based on github.com/gorilla/websocket.

Installation

$ go get -u github.com/shiwano/websocket-conn

Usage

type Conn struct {
  Settings             *Settings
  BinaryMessageHandler func([]byte)
  TextMessageHandler   func(string)
  DisconnectHandler    func()
  ErrorHandler         func(error)
}

func New(ctx context.Context) *Conn
func (c *Conn) Connect(url string, requestHeader http.Header) (*http.Response, error)
func (c *Conn) UpgradeFromHTTP(responseWriter http.ResponseWriter, request *http.Request) error
func (c *Conn) WriteBinaryMessage(data []byte) error
func (c *Conn) WriteTextMessage(text string) error

Examples

Server:

package main

import (
  "context"
  "net/http"
  "github.com/shiwano/websocket-conn"
)

func main() {
  http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
    ctx := context.Background()
    c := conn.New(ctx)
    c.TextMessageHandler = func(text string) {
      c.WriteTextMessage(text + " World")
    }
    if err := c.UpgradeFromHTTP(w, r); err != nil {
      w.Write([]byte("Error"))
    }
  })
  http.ListenAndServe(":5000", nil)
}

Client:

package main

import (
  "context"
  "fmt"
  "github.com/shiwano/websocket-conn"
)

func main() {
  textMessageCh := make(chan string)
  ctx := context.Background()
  c := conn.New(ctx)
  c.TextMessageHandler = func(text string) {
    textMessageCh <- text
  }
  if _, err := c.Connect("ws://localhost:5000", nil); err != nil {
    panic(err)
  }
  c.WriteTextMessage("Hello")
  text := <-textMessageCh
  fmt.Println(text)
}

License

Copyright (c) 2016 Shogo Iwano Licensed under the MIT license.

Documentation

Index

• Variables
• type Conn
  • func New(ctx context.Context) *Conn
  • func (c *Conn) Connect(url string, requestHeader http.Header) (*http.Response, error)
  • func (c *Conn) UpgradeFromHTTP(responseWriter http.ResponseWriter, request *http.Request) error
  • func (c *Conn) WriteBinaryMessage(data []byte) error
  • func (c *Conn) WriteTextMessage(text string) error
• type DialerSettings
• type Settings
• type UpgraderSettings

Variables

var (
	// ErrMessageChannelFull indicates that the connection's envelope channel is full.
	ErrMessageChannelFull = errors.New("websocket-conn: Message channel is full")

	// ErrAlreadyUsed indicates that the connection is already used.
	ErrAlreadyUsed = errors.New("websocket-conn: Already used")
)

Types

type Conn

type Conn struct {
	Settings             *Settings
	BinaryMessageHandler func([]byte)
	TextMessageHandler   func(string)
	DisconnectHandler    func()
	ErrorHandler         func(error)
	// contains filtered or unexported fields
}

Conn represents a WebSocket connection.

func New

func New(ctx context.Context) *Conn

New creates a Conn.

func (*Conn) Connect

func (c *Conn) Connect(url string, requestHeader http.Header) (*http.Response, error)

Connect to the peer.

func (*Conn) UpgradeFromHTTP

func (c *Conn) UpgradeFromHTTP(responseWriter http.ResponseWriter, request *http.Request) error

UpgradeFromHTTP upgrades HTTP to WebSocket.

func (*Conn) WriteBinaryMessage

func (c *Conn) WriteBinaryMessage(data []byte) error

WriteBinaryMessage to the peer.

func (*Conn) WriteTextMessage

func (c *Conn) WriteTextMessage(text string) error

WriteTextMessage to the peer.

type DialerSettings

type DialerSettings struct {
	NetDial         func(network, addr string) (net.Conn, error)
	TLSClientConfig *tls.Config
}

DialerSettings represents websocket.Dialer settings.

type Settings

type Settings struct {
	WriteWait                time.Duration
	PongWait                 time.Duration
	PingPeriod               time.Duration
	HandshakeTimeout         time.Duration
	MessageChannelBufferSize int
	MaxMessageSize           int64
	ReadBufferSize           int
	WriteBufferSize          int
	Subprotocols             []string

	DialerSettings   *DialerSettings
	UpgraderSettings *UpgraderSettings
}

Settings represents connection settings.

type UpgraderSettings

type UpgraderSettings struct {
	Error       func(w http.ResponseWriter, r *http.Request, status int, reason error)
	CheckOrigin func(r *http.Request) bool
}

UpgraderSettings represents websocket.Upgrader settings.