job

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 6, 2022 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Job 

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

Job Wraps JobFun and provide:

  1. Creation, Start, and Finish Time
  2. Recover From Panics

func NewJob 

func NewJob(ctx context.Context, jobFunc func(context.Context)) *Job

NewJob Create new Job, id is assigned a UUID instead.

func NewJobWithID 

func NewJobWithID(ctx context.Context, id string, jobFunc func(context.Context)) *Job

NewJobWithID Create new Job with the supplied Id.

func (*Job) ActualElapsed 

func (j *Job) ActualElapsed() time.Duration

ActualElapsed Return the actual time of procession of Job. Return -1 if job hasn't started yet.

func (*Job) ID 

func (j *Job) ID() string

ID Return Job ID

func (*Job) Run 

func (j *Job) Run() error

Run Run the internal Job (synchronous)

func (*Job) State 

func (j *Job) State() State

State Return Job current state.

func (*Job) TotalElapsed 

func (j *Job) TotalElapsed() time.Duration

TotalElapsed Returns the total time between creation of object and finishing processing its job. Return -1 if job hasn't started yet.

type JobCtxValue 

type JobCtxValue struct{}

type State 

type State int64

State Indicate the state of the Job 

const (
	// NEW Job has just been created and hasn't started yet
	NEW State = iota
	// RUNNING Job started and is running.
	RUNNING
	// FINISHED Job started and finished processing.
	FINISHED
	// PANICKED Job started and finished but encountered a panic.
	PANICKED
)

func (State) String 

func (s State) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.