socket

README

socket

Golang websocket mini client

Documentation

Index

• type Config
• type HandleCloseFunc
• type HandleErrorFunc
• type Manager
  • func New() *Manager
  • func (m *Manager) Broadcast(msg []byte) error
  • func (m *Manager) BroadcastBinary(msg []byte) error
  • func (m *Manager) BroadcastFilter(msg []byte, fn func(*Session) bool) error
  • func (m *Manager) BroadcastMultiple(msg []byte, sessions []Session) error
  • func (m *Manager) BroadcastOthers(msg []byte, s *Session) error
  • func (m *Manager) Close() error
  • func (m *Manager) HandleClose(fn func(code int, text string) error)
  • func (m *Manager) HandleConnect(fn func(*Session))
  • func (m *Manager) HandleDisconnect(fn func(*Session))
  • func (m *Manager) HandleError(fn func(*Session, error))
  • func (m *Manager) HandleMessage(fn func(*Session, []byte))
  • func (m *Manager) HandleMessageBinary(fn func(*Session, []byte))
  • func (m *Manager) HandlePong(fn func(*Session))
  • func (m *Manager) HandleRequest(w http.ResponseWriter, r *http.Request) error
  • func (m *Manager) HandleRequestWithKeys(w http.ResponseWriter, r *http.Request, keys map[string]interface{}) error
  • func (m *Manager) HandleSentMessage(fn func(*Session, []byte))
  • func (m *Manager) HandleSentMessageBinary(fn func(*Session, []byte))
  • func (m *Manager) Len() int
• type Session
  • func (s *Session) SendCloseSignal() error
  • func (s *Session) SendCloseWithMsg(msg []byte) error
  • func (s *Session) SendWithBinary(msg []byte) error
  • func (s *Session) SendWithText(msg []byte) error

Types

type Config

type Config struct {
	WriteWait         time.Duration
	PongWait          time.Duration
	HeartbeatRate     time.Duration
	MaxMessageSize    int64
	MessageBufferSize int
}

type HandleCloseFunc

type HandleCloseFunc func(code int, text string) error

type HandleErrorFunc

type HandleErrorFunc func(*Session, error)

type Manager

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

func New

func New() *Manager

func (*Manager) Broadcast

func (m *Manager) Broadcast(msg []byte) error

func (*Manager) BroadcastBinary

func (m *Manager) BroadcastBinary(msg []byte) error

func (*Manager) BroadcastFilter

func (m *Manager) BroadcastFilter(msg []byte, fn func(*Session) bool) error

func (*Manager) BroadcastMultiple

func (m *Manager) BroadcastMultiple(msg []byte, sessions []Session) error

func (*Manager) BroadcastOthers

func (m *Manager) BroadcastOthers(msg []byte, s *Session) error

func (*Manager) Close

func (m *Manager) Close() error

func (*Manager) HandleClose

func (m *Manager) HandleClose(fn func(code int, text string) error)

func (*Manager) HandleConnect

func (m *Manager) HandleConnect(fn func(*Session))

func (*Manager) HandleDisconnect

func (m *Manager) HandleDisconnect(fn func(*Session))

func (*Manager) HandleError

func (m *Manager) HandleError(fn func(*Session, error))

func (*Manager) HandleMessage

func (m *Manager) HandleMessage(fn func(*Session, []byte))

func (*Manager) HandleMessageBinary

func (m *Manager) HandleMessageBinary(fn func(*Session, []byte))

func (*Manager) HandlePong

func (m *Manager) HandlePong(fn func(*Session))

func (*Manager) HandleRequest

func (m *Manager) HandleRequest(w http.ResponseWriter, r *http.Request) error

func (*Manager) HandleRequestWithKeys

func (m *Manager) HandleRequestWithKeys(w http.ResponseWriter, r *http.Request, keys map[string]interface{}) error

func (*Manager) HandleSentMessage

func (m *Manager) HandleSentMessage(fn func(*Session, []byte))

func (*Manager) HandleSentMessageBinary

func (m *Manager) HandleSentMessageBinary(fn func(*Session, []byte))

func (*Manager) Len

func (m *Manager) Len() int

type Session

type Session struct {
	Request *http.Request
	Keys    map[string]interface{}
	// contains filtered or unexported fields
}

func (*Session) SendCloseSignal

func (s *Session) SendCloseSignal() error

func (*Session) SendCloseWithMsg

func (s *Session) SendCloseWithMsg(msg []byte) error

func (*Session) SendWithBinary

func (s *Session) SendWithBinary(msg []byte) error

func (*Session) SendWithText

func (s *Session) SendWithText(msg []byte) error