client

Documentation

Index

• type Client
  • func New(url, origin string, channelSize int, autoReconnect bool) Client
  • func Open(url, origin string, channelSize int, autoReconnect bool) (Client, error)
• type WSConnection
  • func DefaultConnectionFactory(url string, origin string) (WSConnection, error)
• type WSConnectionFactory

Types

type Client

type Client interface {
	Start() error
	Close()

	Subscribe(path string) error
	Unsubscribe(path string) error

	Send(path string, body string, header string) error
	SendBytes(path string, body []byte, header string) error

	WriteRawMessage(message []byte) error
	Messages() chan *protocol.Message
	StatusMessages() chan *protocol.NotificationMessage
	Errors() chan *protocol.NotificationMessage

	SetWSConnectionFactory(WSConnectionFactory)
	IsConnected() bool
}

func New

func New(url, origin string, channelSize int, autoReconnect bool) Client

New creates a new client, without starting the connection

func Open

func Open(url, origin string, channelSize int, autoReconnect bool) (Client, error)

Open is a shortcut for New() and Start()

type WSConnection

type WSConnection interface {
	WriteMessage(messageType int, data []byte) error
	ReadMessage() (messageType int, p []byte, err error)
	Close() error
}

func DefaultConnectionFactory

func DefaultConnectionFactory(url string, origin string) (WSConnection, error)

type WSConnectionFactory

type WSConnectionFactory func(url string, origin string) (WSConnection, error)