mqueue

README

Simple message queue based on postgres, this is for more realiably sending messages with retry on failure, accepting long failture durations such as discord being down.

Documentation

Index

• func IncrIDCounter() (next int64)
• func QueueMessage(source, sourceID string, guildID, channel int64, msgStr string, ...)
• func QueueMessageEmbed(source, sourceID string, guildID, channel int64, embed *discordgo.MessageEmbed)
• func QueueMessageString(source, sourceID string, guildID, channel int64, message string)
• func RegisterPlugin()
• func RegisterSource(name string, source PluginWithErrorHandler)
• type Plugin
  • func (p *Plugin) LateBotInit()
  • func (p *Plugin) Name() string
  • func (p *Plugin) StopBot(wg *sync.WaitGroup)
• type PluginWithErrorHandler
• type QueuedElement
• type WorkItem

Functions

func IncrIDCounter

func IncrIDCounter() (next int64)

func QueueMessage

func QueueMessage(source, sourceID string, guildID, channel int64, msgStr string, embed *discordgo.MessageEmbed)

func QueueMessageEmbed

func QueueMessageEmbed(source, sourceID string, guildID, channel int64, embed *discordgo.MessageEmbed)

func QueueMessageString

func QueueMessageString(source, sourceID string, guildID, channel int64, message string)

func RegisterPlugin

func RegisterPlugin()

func RegisterSource

func RegisterSource(name string, source PluginWithErrorHandler)

Types

type Plugin

type Plugin struct {
}

func (*Plugin) LateBotInit

func (p *Plugin) LateBotInit()

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) StopBot

func (p *Plugin) StopBot(wg *sync.WaitGroup)

type PluginWithErrorHandler

type PluginWithErrorHandler interface {
	HandleMQueueError(elem *QueuedElement, err error)
}

type QueuedElement

type QueuedElement struct {
	ID int64

	// Where this feed originated from, responsible for handling discord specific errors
	Source string
	// Could be stuff like reddit feed element id, youtube feed element id and so on
	SourceID string

	// The actual message as a simple string
	MessageStr string `json:",omitempty"`

	// The actual message as an embed
	MessageEmbed *discordgo.MessageEmbed `json:",omitempty"`

	// The channel to send the message in
	Channel int64
	Guild   int64
}

type WorkItem

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