emitter

README

go-socketio-redis-emitter

Go implementation of socket.io-emitter using Redis interface

Documentation

Index

• Variables
• func GetMsgPackDecoder(adaptJSON bool) *msgpack.Decoder
• func GetMsgPackEncoder() *msgpack.Encoder
• func MsgPackMarshal(obj any, adaptJSON bool) ([]byte, error)
• func MsgPackUnmarshal(data []byte, obj any, adaptJSON bool) error
• func PutMsgPackDecoder(decoder *msgpack.Decoder)
• func PutMsgPackEncoder(encoder *msgpack.Encoder)
• type Emitter
  • func NewEmitter(opts *Options) *Emitter
  • func (e *Emitter) Broadcast() *Emitter
  • func (e *Emitter) Close()
  • func (e *Emitter) Emit(ctx context.Context, data ...interface{}) (*Emitter, error)
  • func (e *Emitter) In(room string) *Emitter
  • func (e *Emitter) JSON() *Emitter
  • func (e *Emitter) Of(namespace string) *Emitter
  • func (e *Emitter) Reset()
  • func (e *Emitter) To(room string) *Emitter
  • func (e *Emitter) Volatile() *Emitter
• type EmitterSession
• type Options

Variables

var (
	MsgPackEncoderPool = sync.Pool{
		New: func() any {
			encoder := msgpack.NewEncoder(nil)
			encoder.UseCompactInts(true)
			encoder.UseCompactFloats(true)
			return encoder
		},
	}
	MsgPackDecoderPool = sync.Pool{
		New: func() any {
			return msgpack.NewDecoder(nil)
		},
	}
)

Functions

func GetMsgPackDecoder

func GetMsgPackDecoder(adaptJSON bool) *msgpack.Decoder

func GetMsgPackEncoder

func GetMsgPackEncoder() *msgpack.Encoder

func MsgPackMarshal

func MsgPackMarshal(obj any, adaptJSON bool) ([]byte, error)

func MsgPackUnmarshal

func MsgPackUnmarshal(data []byte, obj any, adaptJSON bool) error

func PutMsgPackDecoder

func PutMsgPackDecoder(decoder *msgpack.Decoder)

func PutMsgPackEncoder

func PutMsgPackEncoder(encoder *msgpack.Encoder)

Types

type Emitter

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

Emitter Socket.IO redis base emitter

func NewEmitter

func NewEmitter(opts *Options) *Emitter

NewEmitter Emitter constructor

func (*Emitter) Broadcast

func (e *Emitter) Broadcast() *Emitter

Broadcast flag

func (*Emitter) Close

func (e *Emitter) Close()

Close release redis client

func (*Emitter) Emit

func (e *Emitter) Emit(ctx context.Context, data ...interface{}) (*Emitter, error)

Emit Send the packet

func (*Emitter) In

func (e *Emitter) In(room string) *Emitter

In Limit emission to a certain `room`

func (*Emitter) JSON

func (e *Emitter) JSON() *Emitter

JSON flag

func (*Emitter) Of

func (e *Emitter) Of(namespace string) *Emitter

Of Limit emission to certain `namespace`

func (*Emitter) Reset

func (e *Emitter) Reset()

Reset session data of emitter

func (*Emitter) To

func (e *Emitter) To(room string) *Emitter

To Limit emission to a certain `room`

func (*Emitter) Volatile

func (e *Emitter) Volatile() *Emitter

Volatile flag

type EmitterSession

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

type Options

type Options struct {
	// the name of the key to pub/sub events on as prefix (socket.io)
	Key string

	// Redis instance
	Redis redis.UniversalClient
}

Options ...