astiws

README

Example

Run the 2 following commands at the same time :

$ go run example/manager/main.go -v

$ go run example/client/main.go -v

Documentation

Index

• Constants
• type BodyMessage
• type BodyMessageRead
• type Client
  • func NewClient(c ClientConfiguration) *Client
  • func (c *Client) AddListener(eventName string, f ListenerFunc)
  • func (c *Client) Close() (err error)
  • func (c *Client) DelListener(eventName string)
  • func (c *Client) Dial(addr string) error
  • func (c *Client) DialWithHeaders(addr string, h http.Header) (err error)
  • func (c *Client) HandlePing() error
  • func (c *Client) Read() (err error)
  • func (c *Client) SetListener(eventName string, f ListenerFunc)
  • func (c *Client) Write(eventName string, payload interface{}) (err error)
• type ClientAdapter
• type ClientConfiguration
• type ListenerFunc
• type Manager
  • func NewManager(c ManagerConfiguration) *Manager
  • func (m *Manager) AutoRegisterClient(c *Client)
  • func (m *Manager) Client(k interface{}) (c *Client, ok bool)
  • func (m *Manager) Clients(fn func(k interface{}, c *Client) error)
  • func (m *Manager) Close() error
  • func (m *Manager) CountClients() int
  • func (m *Manager) Loop(fn func(k interface{}, c *Client))
  • func (m *Manager) RegisterClient(k interface{}, c *Client)
  • func (m *Manager) ServeHTTP(w http.ResponseWriter, r *http.Request, a ClientAdapter) (err error)
  • func (m *Manager) UnregisterClient(k interface{})
• type ManagerConfiguration

Constants

const (
	EventNameDisconnect = "astiws.disconnect"
	PingPeriod          = (pingWait * 9) / 10
)

Constants

Types

type BodyMessage

type BodyMessage struct {
	EventName string      `json:"event_name"`
	Payload   interface{} `json:"payload"`
}

BodyMessage represents the body of a message

type BodyMessageRead

type BodyMessageRead struct {
	BodyMessage
	Payload json.RawMessage `json:"payload"`
}

BodyMessageRead represents the body of a message for read purposes Indeed when reading the body, we need the payload to be a json.RawMessage

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client represents a hub client

func NewClient

func NewClient(c ClientConfiguration) *Client

NewClient creates a new client

func (*Client) AddListener

func (c *Client) AddListener(eventName string, f ListenerFunc)

AddListener adds a listener

func (*Client) Close

func (c *Client) Close() (err error)

Close closes the client properly

func (*Client) DelListener

func (c *Client) DelListener(eventName string)

DelListener deletes a listener

func (*Client) Dial

func (c *Client) Dial(addr string) error

Dial dials an addr

func (*Client) DialWithHeaders

func (c *Client) DialWithHeaders(addr string, h http.Header) (err error)

DialWithHeader dials an addr with specific headers

func (*Client) HandlePing

func (c *Client) HandlePing() error

HandlePing handles a ping

func (*Client) Read

func (c *Client) Read() (err error)

Read reads from the client

func (*Client) SetListener

func (c *Client) SetListener(eventName string, f ListenerFunc)

SetListener sets a listener

func (*Client) Write

func (c *Client) Write(eventName string, payload interface{}) (err error)

Write writes a message to the client

type ClientAdapter

type ClientAdapter func(c *Client)

ClientAdapter represents a client adapter func

type ClientConfiguration

type ClientConfiguration struct {
	MaxMessageSize int `toml:"max_message_size"`
}

ClientConfiguration represents a client configuration

type ListenerFunc

type ListenerFunc func(c *Client, eventName string, payload json.RawMessage) error

ListenerFunc represents a listener callback

type Manager

type Manager struct {
	Upgrader websocket.Upgrader
	// contains filtered or unexported fields
}

Manager represents a websocket manager

func NewManager

func NewManager(c ManagerConfiguration) *Manager

NewManager creates a new manager

func (*Manager) AutoRegisterClient

func (m *Manager) AutoRegisterClient(c *Client)

AutoRegisterClient auto registers a new client

func (*Manager) Client

func (m *Manager) Client(k interface{}) (c *Client, ok bool)

Client returns the client stored with the specific key

func (*Manager) Clients

func (m *Manager) Clients(fn func(k interface{}, c *Client) error)

Clients executes a function on every client. It stops if an error is returned.

func (*Manager) Close

func (m *Manager) Close() error

Close implements the io.Closer interface

func (*Manager) CountClients

func (m *Manager) CountClients() int

CountClients returns the number of connected clients

func (*Manager) Loop

func (m *Manager) Loop(fn func(k interface{}, c *Client))

Loop loops in clients and execute a function for each of them

func (*Manager) RegisterClient

func (m *Manager) RegisterClient(k interface{}, c *Client)

RegisterClient registers a new client

func (*Manager) ServeHTTP

func (m *Manager) ServeHTTP(w http.ResponseWriter, r *http.Request, a ClientAdapter) (err error)

ServeHTTP handles an HTTP request and returns an error unlike an http.Handler We don't want to register the client yet, since we may want to index the map of clients with an information we don't have yet

func (*Manager) UnregisterClient

func (m *Manager) UnregisterClient(k interface{})

UnregisterClient unregisters a client astiws.disconnected event is a good place to call this function

type ManagerConfiguration

type ManagerConfiguration struct {
	CheckOrigin    func(r *http.Request) bool `toml:"-"`
	MaxMessageSize int                        `toml:"max_message_size"`
}

ManagerConfiguration represents a manager configuration