blaze

Documentation

Overview

Package blaze integrates the mgojq package to handle asynchronous jobs.

Index

• func C(store *coal.SubStore) *mgojq.Collection
• func JobController(store *coal.Store, authorizers ...fire.Callback) *fire.Controller
• type Job

Functions

func C

func C(store *coal.SubStore) *mgojq.Collection

C will return the correct mgojq.Collection.

func JobController

func JobController(store *coal.Store, authorizers ...fire.Callback) *fire.Controller

JobController will return a basic controller that provides access to the jobs. At least one authorizer should be provided that restricts access to administrators.

Types

type Job

type Job struct {
	coal.Base `json:"-" bson:",inline" coal:"jobs"`
	Name      string    `json:"name"`
	Params    bson.M    `json:"params"`
	Status    string    `json:"status"`
	Created   time.Time `json:"created"`
	Attempts  int       `json:"attempts"`
	Delayed   time.Time `json:"delayed,omitempty" bson:",omitempty"`
	Started   time.Time `json:"started,omitempty" bson:",omitempty"`
	Ended     time.Time `json:"ended,omitempty" bson:",omitempty"`
	Result    bson.M    `json:"result,omitempty" bson:",omitempty"`
	Error     string    `json:"error,omitempty" bson:",omitempty"`
	Reason    string    `json:"reason,omitempty" bson:",omitempty"`
}

Job is the coal model for the mgojq.Job type.