message_handler

Documentation

Index

• Constants
• Variables
• func AckOfflineMessage(id string)
• func GetHandleFn() func(h *MessageHandler, ci *gate.Info, m *messages.GlideMessage)
• func PushOfflineMessage(h *messaging.MessageInterfaceImpl, id string)
• type AuthRequest
• type InternalHandler
  • func (c *InternalHandler) Handle(h *messaging.MessageInterfaceImpl, cliInfo *gate.Info, ...) bool
• type MessageHandler
  • func NewHandlerWithOptions(opts *Options) (*MessageHandler, error)
  • func (d *MessageHandler) AddHandler(i messaging.MessageHandler)
  • func (d *MessageHandler) Handle(cInfo *gate.Info, msg *messages.GlideMessage) error
  • func (d *MessageHandler) InitDefaultHandler(...)
  • func (d *MessageHandler) SetAuthorize(a auth.Interface)
  • func (d *MessageHandler) SetGate(g gate.Gateway)
  • func (d *MessageHandler) SetOfflineMessageHandler(fn func(h *MessageHandler, ci *gate.Info, m *messages.GlideMessage))
  • func (d *MessageHandler) SetSubscription(s subscription.Interface)
• type Options

Constants

const (
	KeyRedisOfflineMsgPrefix = "im:msg:offline:"
)

Variables

var Enable = false

Functions

func AckOfflineMessage

func AckOfflineMessage(id string)

func GetHandleFn

func GetHandleFn() func(h *MessageHandler, ci *gate.Info, m *messages.GlideMessage)

func PushOfflineMessage

func PushOfflineMessage(h *messaging.MessageInterfaceImpl, id string)

Types

type AuthRequest

type AuthRequest struct {
}

type InternalHandler

type InternalHandler struct {
}

func (*InternalHandler) Handle

func (c *InternalHandler) Handle(h *messaging.MessageInterfaceImpl, cliInfo *gate.Info, message *messages.GlideMessage) bool

type MessageHandler

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

MessageHandler .

func NewHandlerWithOptions

func NewHandlerWithOptions(opts *Options) (*MessageHandler, error)

func (*MessageHandler) AddHandler

func (d *MessageHandler) AddHandler(i messaging.MessageHandler)

func (*MessageHandler) Handle

func (d *MessageHandler) Handle(cInfo *gate.Info, msg *messages.GlideMessage) error

func (*MessageHandler) InitDefaultHandler

func (d *MessageHandler) InitDefaultHandler(callback func(action messages.Action, fn messaging.HandlerFunc) messaging.HandlerFunc)

InitDefaultHandler 初始化 message.Action 对应的默认 Handler, 部分类型的 Action 才有默认 Handler, 若要修改特定 Action 的默认 Handler 则可以在 callback 回调中返回你需要的即可, callback 参数 fn 既是该 action 对的默认 Handler.

func (*MessageHandler) SetAuthorize

func (d *MessageHandler) SetAuthorize(a auth.Interface)

func (*MessageHandler) SetGate

func (d *MessageHandler) SetGate(g gate.Gateway)

func (*MessageHandler) SetOfflineMessageHandler

func (d *MessageHandler) SetOfflineMessageHandler(fn func(h *MessageHandler, ci *gate.Info, m *messages.GlideMessage))

SetOfflineMessageHandler called while client is offline

func (*MessageHandler) SetSubscription

func (d *MessageHandler) SetSubscription(s subscription.Interface)

type Options

type Options struct {
	// MessageStore chat message store
	MessageStore store.MessageStore

	// OfflineHandleFn client offline, handle message
	OfflineHandleFn func(h *MessageHandler, ci *gate.Info, pushMessage *messages.GlideMessage)

	// Auth used for client auth action handler messages.ActionApiAuth
	Auth auth.Interface

	// DontInitDefaultHandler true will not init default action handler, MessageHandler.InitDefaultHandler
	DontInitDefaultHandler bool

	// NotifyOnErr true express notify client on server error.
	NotifyOnErr bool
}