oodle

Documentation

Index

• Variables
• type BaseTrigger
  • func (btrigger *BaseTrigger) SetSendQueue(sendqueue chan string)
• type Bot
• type Command
• type CommandInfo
• type Config
• type Join
• type Leave
• type Message
• type Stateful
• type Trigger

Variables

var ErrUsage = errors.New("Wrong command usage")

Types

type BaseTrigger

type BaseTrigger struct {
	SendQueue chan string
}

BaseTrigger is just an implementation of Trigger to reduce some boilerplate code

func (*BaseTrigger) SetSendQueue

func (btrigger *BaseTrigger) SetSendQueue(sendqueue chan string)

type Bot

type Bot interface {
	RegisterTrigger(trigger Trigger)
	RegisterCommand(command Command)
}

type Command

type Command interface {
	Info() CommandInfo
	Execute(nick string, args []string) (reply string, err error)
}

Command is like a pure function just inputs and outputs

type CommandInfo

type CommandInfo struct {
	Prefix      string
	Name        string
	Description string
	Usage       string
}

CommandInfo contains information of a command

type Config

type Config struct {
	Nick        string `toml:"nick"`
	Name        string `toml:"name"`
	User        string `toml:"user"`
	Server      string `toml:"server"`
	Port        int    `toml:"port"`
	Channel     string `toml:"channel"`
	Retry       bool   `toml:"retry"`
	SASLUser    string `toml:"sasl_user"`
	SASLPass    string `toml:"sasl_pass"`
	DBPath      string `toml:"dbpath"`
	WebHookAddr string `toml:"webhook_addr"`
	Secret      string `toml:"secret"`
}

type Join

type Join struct {
	Nick string
}

type Leave

type Leave struct {
	Nick string
}

type Message

type Message struct {
	Nick string
	Msg  string
}

Simpified IRC events

type Stateful

type Stateful interface {
	Init(config *Config, db *gorm.DB)
}

type Trigger

type Trigger interface {
	SetSendQueue(sendqueue chan string)
	OnEvent(event interface{})
}

Trigger can listen for a event and get triggered and send messages via. the send queue