transport

type AddSetter ¶

type AddSetter interface {
	Add(eiot.Transporter) (SocketID, error)
	Set(SocketID, eiot.Transporter) error
}

type Closer ¶

type Closer interface {
	Shutdown(socketID SocketID)
}

type Data ¶

type Data interface{} // The Data packet type

type Emitter ¶

type Emitter interface {
	Sender

	Sockets(ns Namespace) SocketArray
	Rooms(ns Namespace, id SocketID) RoomArray
}

type JoinLeaver ¶

type JoinLeaver interface {
	Join(Namespace, SocketID, Room) error
	Leave(Namespace, SocketID, Room) error
}

type Namespace ¶

type Namespace = string

type Option ¶

type Option = siop.Option

The functional option that can be used with Packets

type Room ¶

type Room = string

type RoomArray ¶

type RoomArray struct {
	Rooms []Room
}

func (a RoomArray) Names() []Room

type SendReceiver ¶

type SendReceiver interface {
	Sender
	Receive(socketID SocketID) <-chan Socket
}

type Sender ¶

type Sender interface {
	Send(SocketID, Data, ...Option) error
}

type SessionID ¶

type SessionID = eios.ID

The EngineIO session ID

type Socket ¶

type Socket struct {
	Type      byte
	Namespace string
	AckID     uint64
	Data      Data
}

Socket is a generic socket that is passed to the emit function during execution

type SocketArray ¶

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

func InitSocketArray(ns Namespace, ids []SocketID, opts ...func(optionWith)) SocketArray

func (a SocketArray) FromRoom(rm Room) (rtn []SocketID, err error)

func (a SocketArray) IDs() []SocketID

func (a SocketArray) LocalWith(id SocketID) (rtn []SocketID, err error)

func (a *SocketArray) With(opts ...option)

type SocketID ¶

type SocketID = sios.ID

The SocketID session ID

type Transport ¶

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

Transport facilitates transferring between the SocketIO transport which is in-memory or something like redis to the EngineIO transport which is HTTP long polling, Websockets or Server-Side events

func NewTransport(id SocketID, eioTransport eiot.Transporter, fn siop.NewPacket) *Transport

func (t *Transport) Receive() <-chan Socket

func (t *Transport) Send(data Data, opts ...Option)

func (t *Transport) SendBuffer()

func (t *Transport) Shutdown()

func (buf Transport) StartBuffer() func()

func (buf Transport) StopBuffer()

type Transporter ¶

type Transporter interface {
	AddSetter
	JoinLeaver
	SendReceiver
	Closer

	AckID() uint64
}