mailroom

README

mailroom

GoLang service responsible for handling flow tasks in RapidPro

Documentation

Index

• func AddInitFunction(initFunc InitFunction)
• func AddTaskFunction(taskType string, taskFunc TaskFunction)
• type Config
  • func NewConfig() *Config
• type Foreman
  • func NewForeman(mr *Mailroom, queue string, maxWorkers int) *Foreman
  • func (f *Foreman) Assign()
  • func (f *Foreman) Start()
  • func (f *Foreman) Stop()
• type InitFunction
• type Mailroom
  • func NewMailroom(config *Config) *Mailroom
  • func (mr *Mailroom) Start() error
  • func (mr *Mailroom) Stop() error
• type TaskFunction
• type Worker
  • func NewWorker(foreman *Foreman, id int) *Worker
  • func (w *Worker) Start()
  • func (w *Worker) Stop()

Functions

func AddInitFunction

func AddInitFunction(initFunc InitFunction)

AddInitFunction adds an init function that will be called on startup

func AddTaskFunction

func AddTaskFunction(taskType string, taskFunc TaskFunction)

AddTaskFunction adds an task function that will be called for a type of task

Types

type Config

type Config struct {
	SentryDSN  string `help:"the DSN used for logging errors to Sentry"`
	DB         string `help:"URL describing how to connect to the RapidPro database"`
	Redis      string `help:"URL describing how to connect to Redis"`
	MaxWorkers int    `help:"the maximum number of go routines that will be used to handle events"`
	Version    string `help:"the version of this mailroom install"`
	LogLevel   string `help:"the logging level courier should use"`
}

Config is our top level configuration object

func NewConfig

func NewConfig() *Config

NewConfig returns a new default configuration object

type Foreman

type Foreman struct {
	// contains filtered or unexported fields
}

Foreman takes care of managing our set of sending workers and assigns msgs for each to send

func NewForeman

func NewForeman(mr *Mailroom, queue string, maxWorkers int) *Foreman

NewForeman creates a new Foreman for the passed in server with the number of max senders

func (*Foreman) Assign

func (f *Foreman) Assign()

Assign is our main loop for the Foreman, it takes care of popping the next outgoing task from our backend and assigning them to workers

func (*Foreman) Start

func (f *Foreman) Start()

Start starts the foreman and all its workers, assigning jobs while there are some

func (*Foreman) Stop

func (f *Foreman) Stop()

Stop stops the foreman and all its workers, the wait group of the worker can be used to track progress

type InitFunction

type InitFunction func(mr *Mailroom) error

InitFunction is a function that will be called when mailroom starts

type Mailroom

type Mailroom struct {
	Config    *Config
	DB        *sqlx.DB
	RedisPool *redis.Pool
	Quit      chan bool
	CTX       context.Context
	Cancel    context.CancelFunc
	WaitGroup sync.WaitGroup
	// contains filtered or unexported fields
}

Mailroom is a service for handling RapidPro events

func NewMailroom

func NewMailroom(config *Config) *Mailroom

NewMailroom creates and returns a new mailroom instance

func (*Mailroom) Start

func (mr *Mailroom) Start() error

Start starts the mailroom service

func (*Mailroom) Stop

func (mr *Mailroom) Stop() error

Stop stops the mailroom service

type TaskFunction

type TaskFunction func(mr *Mailroom, task *queue.Task) error

TaskFunction is the function that will be called for a type of task

type Worker

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

Worker is our type for a single goroutine that is handling queued events

func NewWorker

func NewWorker(foreman *Foreman, id int) *Worker

NewWorker creates a new worker responsible for working on events

func (*Worker) Start

func (w *Worker) Start()

Start starts our Sender's goroutine and has it start waiting for tasks from the foreman

func (*Worker) Stop

func (w *Worker) Stop()

Stop stops our worker