store

Documentation

Index

• Constants
• Variables
• func LoadConfigFromFile(path string)
• func LoadConfigFromString(yamlConfig string)
• func UpdateSession(user User)
• type Config
• type Group
• type Job
  • func FindJob(id string) (Job, error)
  • func (job Job) Delete() error
  • func (job Job) Expire(timeout int) error
  • func (job Job) Update() error
• type Queue
  • func FindQueue(id string) (Queue, error)
  • func FindQueueBySlug(slugToFind string, group Group, create bool) (Queue, error)
  • func ListQueue(group Group) []Queue
  • func (queue Queue) Delete() error
  • func (queue Queue) Update() error
  • func (queue Queue) UpdateAndKeep(toKeepFields []string) error
• type RecurrentJob
  • func FindRecurrentJob(id int) (RecurrentJob, error)
  • func FindRecurrentJobByType(queue Queue, jobType string) (RecurrentJob, error)
  • func (job RecurrentJob) Delete() error
  • func (job RecurrentJob) Update() error
• type User
  • func FindSession(conn net.Conn) User

Constants

const JobDone = "done"

JobDone - the job was processed without issues by the worker

const JobErrored = "errored"

JobErrored - the job was processed but issues happen so it need a rerun

const JobInProgress = "in-progress"

JobInProgress - the job was taken by a worker and being worked out

const JobPending = "pending"

JobPending - the job is in the queue ready to be taken by one of the available worker

const WorkerAvailable = "available"

WorkerAvailable -

const WorkerBusy = "busy"

WorkerBusy -

Variables

var Queues []Queue

Queues - Contain all the stored queues

var Sessions []User

Sessions - all the sessions

Functions

func LoadConfigFromFile

func LoadConfigFromFile(path string)

LoadConfigFromFile -

func LoadConfigFromString

func LoadConfigFromString(yamlConfig string)

LoadConfigFromString -

func UpdateSession

func UpdateSession(user User)

UpdateSession -

Types

type Config

type Config struct {
	Groups        []Group
	Users         []User
	Host          string
	Port          int
	JobTimeout    int    `yaml:"job_timeout"`
	WebPort       int    `yaml:"web_port"`
	DelayPolicy   string `yaml:"delay_policy"`
	LogLevel      string `yaml:"log_level"`
	TestMode      bool   `yaml:"test_mode"`
	AllowDispatch bool   `yaml:"allow_dispatch"`
}

Config -

var Options Config

Options -

type Group

type Group struct {
	Slug string
}

Group - A organization, namespace

type Job

type Job struct {
	ID                  string
	State               string
	Type                string
	Payload             string
	Attempts            int
	StartedProcessingAt time.Time
	EndProcessingAt     time.Time
	Queue               Queue
	Group               Group
}

Job -

func FindJob

func FindJob(id string) (Job, error)

FindJob - find a job in all the queues

func (Job) Delete

func (job Job) Delete() error

Delete - Will delete a job

func (Job) Expire

func (job Job) Expire(timeout int) error

Expire - Will delete a job after a timeout in seconds

func (Job) Update

func (job Job) Update() error

Update - Update a job

type Queue

type Queue struct {
	ID            string
	Slug          string
	Group         Group
	RecurrentJobs []RecurrentJob
	Jobs          []Job
	Workers       []User
}

Queue -

func FindQueue

func FindQueue(id string) (Queue, error)

FindQueue - Will find a queue with a id

func FindQueueBySlug

func FindQueueBySlug(slugToFind string, group Group, create bool) (Queue, error)

FindQueueBySlug - Will find a queue with a slug in a group

If create flag set to true, the queue will be created

func ListQueue

func ListQueue(group Group) []Queue

ListQueue - Return all queues in a group

func (Queue) Delete

func (queue Queue) Delete() error

Delete - Will delete a queue

func (Queue) Update

func (queue Queue) Update() error

Update -

func (Queue) UpdateAndKeep

func (queue Queue) UpdateAndKeep(toKeepFields []string) error

UpdateAndKeep - Will update a queue

type RecurrentJob

type RecurrentJob struct {
	EntryID        int
	Queue          Queue
	Type           string
	CronExpression string
}

RecurrentJob -

func FindRecurrentJob

func FindRecurrentJob(id int) (RecurrentJob, error)

FindRecurrentJob - Find a reccurent job by id

func FindRecurrentJobByType

func FindRecurrentJobByType(queue Queue, jobType string) (RecurrentJob, error)

FindRecurrentJobByType - Find a reccurent job by id

func (RecurrentJob) Delete

func (job RecurrentJob) Delete() error

Delete - Delete a reccurent job

func (RecurrentJob) Update

func (job RecurrentJob) Update() error

Update - Update a reccurent job

type User

type User struct {
	Username     string
	Password     string
	Groups       []string
	Addr         string
	CurrentGroup Group
	Conn         net.Conn
	Status       string
}

User -

func FindSession

func FindSession(conn net.Conn) User

FindSession - will return a user object for this session