msgsystem

Documentation

Overview

ircflu's central messaging system. Handles incoming commands- and outgoing messages-routing.

Index

• Variables
• func RegisterSubSystem(system MsgSubSystem)
• func StartSubSystems()
• type Message
• type MsgSubSystem
  • func GetSubSystem(identifier string) *MsgSubSystem

Variables

var (
	CommandsIn  = make(chan Message)
	MessagesOut = make(chan Message)
)

Functions

func RegisterSubSystem

func RegisterSubSystem(system MsgSubSystem)

Sub-systems need to call this method to register themselves

func StartSubSystems

func StartSubSystems()

Starts all registered messaging sub-systems

Types

type Message

type Message struct {
	To     []string
	Msg    string
	Source string
	Authed bool
}

type MsgSubSystem

type MsgSubSystem interface {
	// Name of the sub-system
	Name() string
	// Activate the sub-system using these in&out channels
	Run(channelIn, channelOut chan Message)
	Handle(msg Message) bool
}

Interface which all messaging sub-systems need to implement

func GetSubSystem

func GetSubSystem(identifier string) *MsgSubSystem

Returns sub-system with this name