plugins

Documentation

Overview

Package plugins defines and maintains supported bot plugins.

Index

• func Dispatch(w irc.ResponseWriter, r *irc.Request)
• func Load(prof irc.Profile)
• func Register(p Plugin)
• func Unload(prof irc.Profile)
• type Plugin

Functions

func Dispatch

func Dispatch(w irc.ResponseWriter, r *irc.Request)

Dispatch sends the given, incoming IRC message to all plugins.

func Load

func Load(prof irc.Profile)

Load initializes all plugins.

func Register

func Register(p Plugin)

Register registers the given plugin. This is meant to be called during program initialization, by imported plugin packages.

func Unload

func Unload(prof irc.Profile)

Unload unloads all plugins.

Types

type Plugin

type Plugin interface {
	// Load initializes the module and loads any internal resources
	// which may be required.
	Load(irc.Profile) error

	// Unload cleans the module up and unloads any internal resources.
	Unload(irc.Profile) error

	// Dispatch sends the given, incoming IRC message to the plugin for
	// processing as it sees fit.
	Dispatch(irc.ResponseWriter, *irc.Request)
}

Plugin defines the interface for a single plugin.