ws

Documentation

Index

• func Broadcast(data []byte, filter *Filter) error
• func BroadcastBinary(data []byte, filter *Filter) error
• func Init(ctx contextx.Context, r *gin.RouterGroup, opfs ...func(opt Options))
• type Filter
  • func NewBlacklistFilter(key string, vals ...interface{}) *Filter
  • func NewWhitelistFilter(key string, vals ...interface{}) *Filter
  • func (f *Filter) AddKeys(key string, vals ...interface{})
• type Options

Functions

func Broadcast

func Broadcast(data []byte, filter *Filter) error

func BroadcastBinary

func BroadcastBinary(data []byte, filter *Filter) error

func Init

func Init(ctx contextx.Context, r *gin.RouterGroup, opfs ...func(opt Options))

Types

type Filter

type Filter struct {
	Keys map[string]map[interface{}]struct{}
	// contains filtered or unexported fields
}

func NewBlacklistFilter

func NewBlacklistFilter(key string, vals ...interface{}) *Filter

func NewWhitelistFilter

func NewWhitelistFilter(key string, vals ...interface{}) *Filter

func (*Filter) AddKeys

func (f *Filter) AddKeys(key string, vals ...interface{})

type Options

type Options interface {
	SetCallTimeout(t time.Duration)
	SetRelativePath(relativePath string)
	SetKeys(keys ...string)
	SetAuth(auth func(c *gin.Context))

	HandleConnect(fn func(*melody.Session))
	HandleDisconnect(fn func(*melody.Session))
	HandlePong(fn func(*melody.Session))
	HandleMessage(fn func(*melody.Session, []byte))
	HandleMessageBinary(fn func(*melody.Session, []byte))
	HandleSentMessage(fn func(*melody.Session, []byte))
	HandleSentMessageBinary(fn func(*melody.Session, []byte))
	HandleError(fn func(*melody.Session, error))
	HandleClose(fn func(*melody.Session, int, string) error)
}