msgsystem

package

v0.0.0-...-31a8ea0 Latest Latest Go to latest Published: Oct 23, 2020 License: MIT Imports: 2 Imported by: 16

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/muesli/ircflu

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

View Source

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

Source Files ¶

View all Source files

msgsystem.go

Directories ¶

Path	Synopsis
catserver Based on gocat's catserver by Richard Jones - https://github.com/RJ/gocat Listens on a TCP port, parses first line for addressees, puts Message onto the out channel.	Based on gocat's catserver by Richard Jones - https://github.com/RJ/gocat Listens on a TCP port, parses first line for addressees, puts Message onto the out channel.
irc ircflu's IRC client subsystem.	ircflu's IRC client subsystem.
irctools A collection of convenient IRC styling methods.	A collection of convenient IRC styling methods.
jabber ircflu's Jabber subsystem.	ircflu's Jabber subsystem.
web ircflu's integrated web-server to handle web-hooks.	ircflu's integrated web-server to handle web-hooks.
hooks ircflu's web-hook subsystem.	ircflu's web-hook subsystem.
hooks/github A GitHub web-hook sending messages when new commits arrive.	A GitHub web-hook sending messages when new commits arrive.
hooks/gitlab A GitLab web-hook sending messages when new commits arrive.	A GitLab web-hook sending messages when new commits arrive.
hooks/jira A Jira web-hook sending messages when new commits arrive.	A Jira web-hook sending messages when new commits arrive.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL