# README

go-ws-websocket

go-ws-websocket is a package that Websocket clients which are registered a broker broadcast messages.

Installation

$ go get -u github.com/gjbae1212/go-ws-websocket

Usage

# create braker
broker, _ :=  NewBreaker()

# register 
client, _ := broker.Register(websocket)

# unregister 
_ = broker.Register(client)

# broadcast message
_ = broker.BroadCast(message)

LICENSE

This project is following The MIT.

# Functions

NewBreaker

NewBreaker returns a breaker for websocket.

NewClient

NewClient creates client for websocket.

WithErrorHandlerOption

WithErrorHandlerOption returns a function which sets error handler.

WithMaxMessagePoolLength

WithMaxMessagePoolLength returns a function that sets a pool size, which how many data sends with nonblocking.

WithMaxReadLimit

WithMaxReadLimit returns a function which sets max size how many data reads from websocket.