awg

README

awg

adidis worker framework in Go

Documentation

Overview

Package awg provides "a worker in go"

awg is designed to be compatible with github.com/foxbot/adidis, a distributed discord sharder. It should work with any sharder that sends JSON-encoded Discord events over a Redis gateway keyed with `exchange:events` - though this can pretty easily be adapted to work in your environment.

sub-packages are provided to help make writing a fully-fledged bot with this worker easier.

Index

• Constants
• type IWorker
• type Worker
  • func NewWorker(id, redisAddr, discordAddr string) (*Worker, error)
  • func (worker *Worker) Close()
  • func (worker *Worker) Discord() *wumpus.Discord
  • func (worker *Worker) Messages() <-chan wumpus.Message
  • func (worker *Worker) Run() <-chan error

Constants

const (
	// KeyExchange is the key for the events exchange
	KeyExchange = "exchange:events"
)

Types

type IWorker

type IWorker interface {
	Discord() *wumpus.Discord
	Messages() <-chan wumpus.Message
}

IWorker defines an interface for a worker

type Worker

type Worker struct {
	ID string
	// contains filtered or unexported fields
}

Worker will pull and parse data from Redis

func NewWorker

func NewWorker(id, redisAddr, discordAddr string) (*Worker, error)

NewWorker creates a new worker at the given redis address

func (*Worker) Close

func (worker *Worker) Close()

Close closes the worker

func (*Worker) Discord

func (worker *Worker) Discord() *wumpus.Discord

Discord returns the worker's discord access

func (*Worker) Messages

func (worker *Worker) Messages() <-chan wumpus.Message

Messages returns a readonly chan of incoming messages

func (*Worker) Run

func (worker *Worker) Run() <-chan error

Run runs the worker