astiworker

README

Worker

// Init worker
var w = astiworker.NewWorker()

// Handle signals
w.HandleSignals()

// Serve
w.Serve("127.0.0.1:4000", myHandler)

// Execute
h, _ := w.Exec("sleep", "10")
go func() {
	time.Sleep(3 * time.Second)
	h.Stop()
}

// Wait
w.Wait()

Documentation

Index

• Constants
• type ConfigurationConsumer
• type DialOptions
• type ExecHandler
• type ExecOptions
• type SignalHandler
  • func TermSignalHandler(f func()) SignalHandler
• type Task
  • func (t *Task) Do(f func())
  • func (t *Task) Done()
  • func (t *Task) NewSubTask() *Task
  • func (t *Task) Wait()
• type TaskFunc
• type Worker
  • func NewWorker() (w *Worker)
  • func (w *Worker) Consume(a *astiamqp.AMQP, cs ...ConfigurationConsumer) (err error)
  • func (w *Worker) Context() context.Context
  • func (w *Worker) Dial(o DialOptions)
  • func (w *Worker) Exec(o ExecOptions) (ExecHandler, error)
  • func (w *Worker) HandleSignals(hs ...SignalHandler)
  • func (w *Worker) NewTask() *Task
  • func (w *Worker) Serve(addr string, h http.Handler)
  • func (w *Worker) Stop()
  • func (w *Worker) Wait()

Constants

const (
	StatusCrashed = "crashed"
	StatusRunning = "running"
	StatusStopped = "stopped"
)

Statuses

Types

type ConfigurationConsumer

type ConfigurationConsumer struct {
	AMQP        astiamqp.ConfigurationConsumer
	WorkerCount int
}

ConfigurationConsumer represents a consumer configuration

type DialOptions

type DialOptions struct {
	Addr        string
	Client      *astiws.Client
	Header      http.Header
	OnDial      func() error
	OnReadError func(err error)
}

DialOptions represents dial options

type ExecHandler

type ExecHandler interface {
	Status() string
	Stop()
}

ExecHandler represents an object capable of handling the execution of a cmd

type ExecOptions

type ExecOptions struct {
	Args       []string
	CmdAdapter func(cmd *exec.Cmd, h ExecHandler) error
	Name       string
	StopFunc   func(cmd *exec.Cmd) error
}

type SignalHandler

type SignalHandler func(s os.Signal)

SignalHandler represents a func that can handle a signal

func TermSignalHandler

func TermSignalHandler(f func()) SignalHandler

TermSignalHandler returns a SignalHandler that is executed only on a term signal

type Task

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

Task represents a task

func (*Task) Do

func (t *Task) Do(f func())

Do executes the task

func (*Task) Done

func (t *Task) Done()

Done indicates the task is done

func (*Task) NewSubTask

func (t *Task) NewSubTask() *Task

NewSubTask creates a new sub task

func (*Task) Wait

func (t *Task) Wait()

Wait waits for the task to be finished

type TaskFunc

type TaskFunc func() *Task

TaskFunc represents a function that can create a new task

type Worker

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

Worker represents an object capable of blocking, handling signals and stopping

func NewWorker

func NewWorker() (w *Worker)

NewWorker builds a new worker

func (*Worker) Consume

func (w *Worker) Consume(a *astiamqp.AMQP, cs ...ConfigurationConsumer) (err error)

Consume consumes AMQP events

func (*Worker) Context

func (w *Worker) Context() context.Context

Context returns the worker's context

func (*Worker) Dial

func (w *Worker) Dial(o DialOptions)

Dial dials with options It's the responsibility of the caller to close the Client

func (*Worker) Exec

func (w *Worker) Exec(o ExecOptions) (ExecHandler, error)

Exec executes a cmd The process will be stopped when the worker stops

func (*Worker) HandleSignals

func (w *Worker) HandleSignals(hs ...SignalHandler)

HandleSignals handles signals

func (*Worker) NewTask

func (w *Worker) NewTask() *Task

NewTask creates a new task

func (*Worker) Serve

func (w *Worker) Serve(addr string, h http.Handler)

Serve spawns a server

func (*Worker) Stop

func (w *Worker) Stop()

Stop stops the Worker

func (*Worker) Wait

func (w *Worker) Wait()

Wait is a blocking pattern