gorilla

Documentation

Index

• Constants
• Variables
• type Option
• type WebSocket
  • func Create() *WebSocket
  • func (ws *WebSocket) Close() error
  • func (ws *WebSocket) Connect(url string) (conn.Connection, error)
  • func (ws *WebSocket) LiveNotifications(liveQueryID string) (chan model.Notification, error)
  • func (ws *WebSocket) Logger(logData logger.Logger) *WebSocket
  • func (ws *WebSocket) RawLogger(logData logger.Logger) *WebSocket
  • func (ws *WebSocket) Send(method string, params []interface{}) (interface{}, error)
  • func (ws *WebSocket) SetCompression(compress bool) *WebSocket
  • func (ws *WebSocket) SetTimeOut(timeout time.Duration) *WebSocket

Constants

const (
	// RequestIDLength size of id sent on WS request
	RequestIDLength = 16
	// CloseMessageCode identifier the message id for a close request
	CloseMessageCode = 1000
	// DefaultTimeout timeout in seconds
	DefaultTimeout = 30
)

Variables

var (
	ErrIDInUse           = errors.New("id already in use")
	ErrTimeout           = errors.New("timeout")
	ErrInvalidResponseID = errors.New("invalid response id")
)

Types

type Option

type Option func(ws *WebSocket) error

type WebSocket

type WebSocket struct {
	Conn *gorilla.Conn

	Timeout time.Duration
	Option  []Option
	// contains filtered or unexported fields
}

func Create

func Create() *WebSocket

func (*WebSocket) Close

func (ws *WebSocket) Close() error

func (*WebSocket) Connect

func (ws *WebSocket) Connect(url string) (conn.Connection, error)

func (*WebSocket) LiveNotifications

func (ws *WebSocket) LiveNotifications(liveQueryID string) (chan model.Notification, error)

func (*WebSocket) Logger

func (ws *WebSocket) Logger(logData logger.Logger) *WebSocket

If path is empty it will use os.stdout/os.stderr

func (*WebSocket) RawLogger

func (ws *WebSocket) RawLogger(logData logger.Logger) *WebSocket

func (*WebSocket) Send

func (ws *WebSocket) Send(method string, params []interface{}) (interface{}, error)

func (*WebSocket) SetCompression

func (ws *WebSocket) SetCompression(compress bool) *WebSocket

func (*WebSocket) SetTimeOut

func (ws *WebSocket) SetTimeOut(timeout time.Duration) *WebSocket