messaging

Documentation

Index

• func DefaultMessageValidator(msg *messages.GlideMessage) (error, *messages.GlideMessage)
• type ActionHandler
  • func NewActionHandler(action messages.Action, fn HandlerFunc) *ActionHandler
  • func (a *ActionHandler) Handle(h *MessageInterfaceImpl, cliInfo *gate.Info, message *messages.GlideMessage) bool
• type ActionWithReplyHandler
  • func NewActionWithReplyHandler(action messages.Action, fn ReplyHandlerFunc) *ActionWithReplyHandler
  • func (rh *ActionWithReplyHandler) Handle(h *MessageInterfaceImpl, cInfo *gate.Info, msg *messages.GlideMessage) bool
• type HandlerFunc
• type Interface
• type MessageHandler
• type MessageInterfaceImpl
  • func NewDefaultImpl(options *Options) (*MessageInterfaceImpl, error)
  • func (d *MessageInterfaceImpl) AddHandler(i MessageHandler)
  • func (d *MessageInterfaceImpl) GetClientInterface() gate.Gateway
  • func (d *MessageInterfaceImpl) GetGroupInterface() subscription.Interface
  • func (d *MessageInterfaceImpl) Handle(cInfo *gate.Info, msg *messages.GlideMessage) error
  • func (d *MessageInterfaceImpl) OnHandleMessageError(cInfo *gate.Info, msg *messages.GlideMessage, err error)
  • func (d *MessageInterfaceImpl) SetGate(g gate.Gateway)
  • func (d *MessageInterfaceImpl) SetNotifyErrorOnServer(enable bool)
  • func (d *MessageInterfaceImpl) SetSubscription(g subscription.Interface)
• type MessageValidationHandler
  • func NewMessageValidationHandler(validators ...MessageValidator) *MessageValidationHandler
  • func (m *MessageValidationHandler) Handle(h *MessageInterfaceImpl, cliInfo *gate.Info, message *messages.GlideMessage) bool
• type MessageValidator
• type Messaging
• type Options
• type ReplyHandlerFunc
• type Server

Functions

func DefaultMessageValidator

func DefaultMessageValidator(msg *messages.GlideMessage) (error, *messages.GlideMessage)

Types

type ActionHandler

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

ActionHandler is a handler for a specific message action.

func NewActionHandler

func NewActionHandler(action messages.Action, fn HandlerFunc) *ActionHandler

func (*ActionHandler) Handle

func (a *ActionHandler) Handle(h *MessageInterfaceImpl, cliInfo *gate.Info, message *messages.GlideMessage) bool

type ActionWithReplyHandler

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

ActionWithReplyHandler is a handler for a specific message action, this handler will return a reply message.

func NewActionWithReplyHandler

func NewActionWithReplyHandler(action messages.Action, fn ReplyHandlerFunc) *ActionWithReplyHandler

func (*ActionWithReplyHandler) Handle

func (rh *ActionWithReplyHandler) Handle(h *MessageInterfaceImpl, cInfo *gate.Info, msg *messages.GlideMessage) bool

type HandlerFunc

type HandlerFunc func(cliInfo *gate.Info, message *messages.GlideMessage) error

HandlerFunc is used to handle message with specified action in ActionHandler

type Interface

type Interface interface {

	// Handle handles message from gate, the entry point for the messaging.
	Handle(clientInfo *gate.Info, msg *messages.GlideMessage) error

	AddHandler(i MessageHandler)
}

Interface for messaging.

type MessageHandler

type MessageHandler interface {
	// Handle handles the message, returns true if the message is handled,
	// otherwise the message is delegated to next handler.
	Handle(h *MessageInterfaceImpl, cliInfo *gate.Info, message *messages.GlideMessage) bool
}

MessageHandler is the interface for message handler

type MessageInterfaceImpl

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

MessageInterfaceImpl default implementation of the messaging interface.

func NewDefaultImpl

func NewDefaultImpl(options *Options) (*MessageInterfaceImpl, error)

func (*MessageInterfaceImpl) AddHandler

func (d *MessageInterfaceImpl) AddHandler(i MessageHandler)

func (*MessageInterfaceImpl) GetClientInterface

func (d *MessageInterfaceImpl) GetClientInterface() gate.Gateway

func (*MessageInterfaceImpl) GetGroupInterface

func (d *MessageInterfaceImpl) GetGroupInterface() subscription.Interface

func (*MessageInterfaceImpl) Handle

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

func (*MessageInterfaceImpl) OnHandleMessageError

func (d *MessageInterfaceImpl) OnHandleMessageError(cInfo *gate.Info, msg *messages.GlideMessage, err error)

func (*MessageInterfaceImpl) SetGate

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

func (*MessageInterfaceImpl) SetNotifyErrorOnServer

func (d *MessageInterfaceImpl) SetNotifyErrorOnServer(enable bool)

func (*MessageInterfaceImpl) SetSubscription

func (d *MessageInterfaceImpl) SetSubscription(g subscription.Interface)

type MessageValidationHandler

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

MessageValidationHandler validates message before handling

func NewMessageValidationHandler

func NewMessageValidationHandler(validators ...MessageValidator) *MessageValidationHandler

func (*MessageValidationHandler) Handle

func (m *MessageValidationHandler) Handle(h *MessageInterfaceImpl, cliInfo *gate.Info, message *messages.GlideMessage) bool

type MessageValidator

type MessageValidator = func(msg *messages.GlideMessage) (error, *messages.GlideMessage)

MessageValidator is used to validate message. if error is not nil, this message will be handled by MessageValidationHandler the second return value is the reply message, if not nil, the message will be sent to the client, if nil, the MessageValidationHandler will return the error message

type Messaging

type Messaging interface {
	Interface

	SetSubscription(g subscription.Interface)

	SetGate(g gate.Gateway)
}

type Options

type Options struct {
	NotifyServerError     bool
	MaxMessageConcurrency int
}

type ReplyHandlerFunc

type ReplyHandlerFunc func(cliInfo *gate.Info, message *messages.GlideMessage) (*messages.GlideMessage, error)

type Server

type Server interface {
	Messaging

	Run() error
}

Server is the messaging server.