client

package

v0.0.0-...-c07ec26 Latest Latest Go to latest Published: Feb 3, 2022 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/B3rs/gork

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
- func NewClient(database *sql.DB) *Client
type OptionFunc
type TxClient

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

func NewClient ¶

func NewClient(database *sql.DB) *Client

func (Client) Cancel ¶

func (c Client) Cancel(ctx context.Context, id string) error

Cancel cancels a job in the queue if not already executed

func (Client) Get ¶

func (c Client) Get(ctx context.Context, id string) (jobs.Job, error)

Get returns job with the given id

func (Client) Schedule ¶

func (c Client) Schedule(ctx context.Context, id string, queueName string, arguments interface{}, options ...OptionFunc) error

Schedule schedules a job in the queue to be executed as soon as possible

func (Client) ScheduleNow ¶

func (c Client) ScheduleNow(ctx context.Context, id string) error

ScheduleNow reschedules a job in the queue to be executed immediately

func (Client) WithTx ¶

func (c Client) WithTx(tx *sql.Tx) TxClient

WithTx returns a new client with the given transaction

type OptionFunc ¶

type OptionFunc func(j jobs.Job) jobs.Job

func WithMaxRetries ¶

func WithMaxRetries(tries int) OptionFunc

func WithRetryInterval ¶

func WithRetryInterval(interval time.Duration) OptionFunc

func WithScheduleTime ¶

func WithScheduleTime(t time.Time) OptionFunc

type TxClient ¶

type TxClient interface {
	Schedule(ctx context.Context, id string, queueName string, arguments interface{}, options ...OptionFunc) error
	Cancel(ctx context.Context, id string) error
	ScheduleNow(ctx context.Context, id string) error
	Get(ctx context.Context, id string) (jobs.Job, error)
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL