websocket

Documentation

Index

• func Destroy()
• func Init()
• type BroadCastFilterCallback
• type ConnectionOption
  • func WithConnectionContext(context map[string]any) ConnectionOption
• type HandleCloseFunc
• type HandleConnectFunc
• type HandleDisconnectFunc
• type HandleErrorFunc
• type HandleMessageFunc
• type HandlePongFunc
• type InitOption
  • func InitWithConcurrentMessageHandling(concurrentMessageHandling bool) InitOption
  • func InitWithMaxMessageBufferSize(messageBufferSize int) InitOption
  • func InitWithMaxMessageSize(maxMessageSize int64) InitOption
  • func InitWithPingPeriodSec(pingPeriodSec int64) InitOption
  • func InitWithPongWaitSec(pongWaitSec int64) InitOption
  • func InitWithWriteWaitSec(writeWaitSec int64) InitOption
• type InitOptions
• type Manager
  • func GetInstance() *Manager
  • func (m *Manager) BroadCast(groupID string, msg []byte) error
  • func (m *Manager) BroadCastFilter(groupID string, msg []byte, filterCallback BroadCastFilterCallback) error
  • func (m *Manager) HandleClose(groupID string, handleCloseFunc HandleCloseFunc)
  • func (m *Manager) HandleConnect(groupID string, handleConnectFunc HandleConnectFunc)
  • func (m *Manager) HandleDisconnect(groupID string, handleDisconnectFunc HandleDisconnectFunc)
  • func (m *Manager) HandleError(groupID string, handleErrorFunc HandleErrorFunc)
  • func (m *Manager) HandleMessage(groupID string, handleMessageFunc HandleMessageFunc) error
  • func (m *Manager) HandlePong(groupID string, handlePongFunc HandlePongFunc)
  • func (m *Manager) HandleRequest(groupID string, w http.ResponseWriter, r *http.Request, ...) error
  • func (m *Manager) RegisterHub(groupID string, opts ...InitOption)
  • func (m *Manager) UnregisterHub(groupID string)

Functions

func Destroy

func Destroy()

func Init

func Init()

Types

type BroadCastFilterCallback

type BroadCastFilterCallback func(context map[string]any) bool

type ConnectionOption

type ConnectionOption func(sessionMap *map[string]any)

func WithConnectionContext

func WithConnectionContext(context map[string]any) ConnectionOption

type HandleCloseFunc

type HandleCloseFunc func(i int, s string, context map[string]any) error

type HandleConnectFunc

type HandleConnectFunc func(context map[string]any)

type HandleDisconnectFunc

type HandleDisconnectFunc func(context map[string]any)

type HandleErrorFunc

type HandleErrorFunc func(err error, context map[string]any)

type HandleMessageFunc

type HandleMessageFunc func(message []byte, context map[string]any)

type HandlePongFunc

type HandlePongFunc func(context map[string]any)

type InitOption

type InitOption func(*InitOptions)

func InitWithConcurrentMessageHandling

func InitWithConcurrentMessageHandling(concurrentMessageHandling bool) InitOption

func InitWithMaxMessageBufferSize

func InitWithMaxMessageBufferSize(messageBufferSize int) InitOption

func InitWithMaxMessageSize

func InitWithMaxMessageSize(maxMessageSize int64) InitOption

func InitWithPingPeriodSec

func InitWithPingPeriodSec(pingPeriodSec int64) InitOption

func InitWithPongWaitSec

func InitWithPongWaitSec(pongWaitSec int64) InitOption

func InitWithWriteWaitSec

func InitWithWriteWaitSec(writeWaitSec int64) InitOption

type InitOptions

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

type Manager

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

func GetInstance

func GetInstance() *Manager

func (*Manager) BroadCast

func (m *Manager) BroadCast(groupID string, msg []byte) error

func (*Manager) BroadCastFilter

func (m *Manager) BroadCastFilter(groupID string, msg []byte, filterCallback BroadCastFilterCallback) error

func (*Manager) HandleClose

func (m *Manager) HandleClose(groupID string, handleCloseFunc HandleCloseFunc)

func (*Manager) HandleConnect

func (m *Manager) HandleConnect(groupID string, handleConnectFunc HandleConnectFunc)

func (*Manager) HandleDisconnect

func (m *Manager) HandleDisconnect(groupID string, handleDisconnectFunc HandleDisconnectFunc)

func (*Manager) HandleError

func (m *Manager) HandleError(groupID string, handleErrorFunc HandleErrorFunc)

func (*Manager) HandleMessage

func (m *Manager) HandleMessage(groupID string, handleMessageFunc HandleMessageFunc) error

func (*Manager) HandlePong

func (m *Manager) HandlePong(groupID string, handlePongFunc HandlePongFunc)

func (*Manager) HandleRequest

func (m *Manager) HandleRequest(groupID string, w http.ResponseWriter, r *http.Request, opts ...ConnectionOption) error

func (*Manager) RegisterHub

func (m *Manager) RegisterHub(groupID string, opts ...InitOption)

func (*Manager) UnregisterHub

func (m *Manager) UnregisterHub(groupID string)