pushKit

Documentation

Index

• Variables
• type BaseChannel
  • func (channel *BaseChannel) IsClosed() (rst bool)
  • func (channel *BaseChannel) SetClosed() (flag bool)
• type Channel
• type Listener
• type Listeners
  • func NewListeners(listener Listener) Listeners
  • func (listeners Listeners) OnClose(channel Channel, closeInfo string)
  • func (listeners Listeners) OnFailure(w http.ResponseWriter, r *http.Request, failureInfo string)
  • func (listeners Listeners) OnHandshake(w http.ResponseWriter, r *http.Request, channel Channel)
  • func (listeners Listeners) OnMessage(channel Channel, messageType int, data []byte)

Variables

var (
	ChannelClosedError = errorKit.New("Channel is already closed")
)

Types

type BaseChannel

type BaseChannel struct {
	Id    string
	Bsid  string
	User  string
	Group string

	RWMutex mutexKit.RWMutex

	Data   interface{}
	Closed bool

	Listeners Listeners
}

func (*BaseChannel) IsClosed

func (channel *BaseChannel) IsClosed() (rst bool)

func (*BaseChannel) SetClosed

func (channel *BaseChannel) SetClosed() (flag bool)

SetClosed

PS: 如果返回值为true，应当触发 listener.onClose().

@return true: 设置成功

false:	设置失败（因为已经被设置关闭）

type Channel

type Channel interface {
	// Close 后端主动关闭通道.
	Close() error

	Push(data []byte) error

	IsClosed() (rst bool)

	SetClosed() (flag bool)
}

type Listener

type Listener interface {
	OnFailure(w http.ResponseWriter, r *http.Request, failureInfo string)

	OnHandshake(w http.ResponseWriter, r *http.Request, channel Channel)

	// OnMessage 收到 客户端 发来的消息.
	/*
		PS: 仅适用于WebSocket连接，因为SSE连接是单工的.
	*/
	OnMessage(channel Channel, messageType int, data []byte)

	OnClose(channel Channel, closeInfo string)
}

type Listeners

type Listeners []Listener

func NewListeners

func NewListeners(listener Listener) Listeners

func (Listeners) OnClose

func (listeners Listeners) OnClose(channel Channel, closeInfo string)

func (Listeners) OnFailure

func (listeners Listeners) OnFailure(w http.ResponseWriter, r *http.Request, failureInfo string)

func (Listeners) OnHandshake

func (listeners Listeners) OnHandshake(w http.ResponseWriter, r *http.Request, channel Channel)

func (Listeners) OnMessage

func (listeners Listeners) OnMessage(channel Channel, messageType int, data []byte)