client

May 20, 2024

Changes in this version

type Batch

+ func (b *Batch) PushBulk(jobs []*Job) (map[string]string, error)

type Client

+ func (c *Client) CurrentState() (*FaktoryState, error)

+ type DataSnapshot struct

+ Queues map[string]uint64

+ Sets map[string]uint64

+ Tasks map[string]map[string]interface{}

+ TotalEnqueued uint64

+ TotalFailures uint64

+ TotalProcessed uint64

+ TotalQueues uint64

+ type FaktoryState struct

+ Data DataSnapshot

+ Now string

+ Server ServerSnapshot

+ ServerUtcTime string

+ type HIv2 struct

+ I int

+ S string

+ V int

+ type ServerSnapshot struct

+ CommandCount uint64

+ Connections uint64

+ Description string

+ Uptime uint64

+ UsedMemoryMB uint64

+ Version string

Oct 3, 2022

Changes in this version

type Client

+ func (c *Client) RemoveQueues(names ...string) error

Jun 7, 2022

Changes in this version

+ var ErrBatchAlreadyCommitted = fmt.Errorf("batch has already been committed, must reopen")

+ var ErrBatchNotOpen = fmt.Errorf("batch must be opened before it can be used")

Nov 15, 2021

Changes in this version

+ var RetryPolicyDefault = 25

+ var RetryPolicyDirectToMorgue = -1

+ var RetryPolicyEmphemeral = 0

type Client

+ func (c *Client) PushBulk(jobs []*Job) (map[string]string, error)

type Failure

+ RetryRemaining int

Oct 12, 2021

Changes in this version

type Job

+ func (j *Job) SetExpiresIn(expiresIn time.Duration) *Job

Jul 14, 2021

Changes in this version

type Client

+ func (c *Client) QueueSizes() (map[string]uint64, error)

type ClientData

+ Username string

type Server

+ Username string

Apr 15, 2021

Changes in this version

+ const ExpectedProtocolVersion — windows/amd64

+ var BatchAlreadyCommitted = fmt.Errorf("Batch has already been committed, must reopen") — windows/amd64

+ var BatchNotOpen = fmt.Errorf("Batch must be opened before it can be used") — windows/amd64

+ var Everything = JobFilter — windows/amd64

+ var Labels = []string — windows/amd64

+ var Name = "Faktory" — windows/amd64

+ var RandomProcessWid = "" — windows/amd64

+ var Version = "1.5.1" — windows/amd64

+ func RandomJid() string — windows/amd64

+ func RssKb() int64 — windows/amd64

+ type Batch struct — windows/amd64

+ Bid string

+ Complete *Job

+ Description string

+ ParentBid string

+ Success *Job

+ func NewBatch(cl *Client) *Batch

+ func (b *Batch) Commit() error

+ func (b *Batch) Jobs(fn func() error) error

+ func (b *Batch) Push(job *Job) error

+ type BatchStatus struct — windows/amd64

+ Bid string

+ CompleteState string

+ CreatedAt string

+ Description string

+ Failed int64

+ ParentBid string

+ Pending int64

+ SuccessState string

+ Total int64

+ type Client struct — windows/amd64

+ Location string

+ Options *ClientData

+ func Dial(srv *Server, password string) (*Client, error)

+ func DialWithDialer(srv *Server, password string, dialer Dialer) (*Client, error)

+ func Open() (*Client, error)

+ func OpenWithDialer(dialer Dialer) (*Client, error)

+ func (c *Client) Ack(jid string) error

+ func (c *Client) BatchCommit(bid string) error

+ func (c *Client) BatchNew(def *Batch) (*Batch, error)

+ func (c *Client) BatchOpen(bid string) (*Batch, error)

+ func (c *Client) BatchStatus(bid string) (*BatchStatus, error)

+ func (c *Client) Beat(args ...string) (string, error)

+ func (c *Client) Clear(name Structure) error

+ func (c *Client) Close() error

+ func (c *Client) Discard(name Structure, filter JobFilter) error

+ func (c *Client) Fail(jid string, err error, backtrace []byte) error

+ func (c *Client) Fetch(q ...string) (*Job, error)

+ func (c *Client) Flush() error

+ func (c *Client) Generic(cmdline string) (string, error)

+ func (c *Client) Info() (map[string]interface{}, error)

+ func (c *Client) Kill(name Structure, filter JobFilter) error

+ func (c *Client) PauseQueues(names ...string) error

+ func (c *Client) Push(job *Job) error

+ func (c *Client) Requeue(name Structure, filter JobFilter) error

+ func (c *Client) ResumeQueues(names ...string) error

+ func (c *Client) TrackGet(jid string) (*JobTrack, error)

+ func (c *Client) TrackSet(jid string, percent int, desc string, reserveUntil *time.Time) error

+ type ClientData struct — windows/amd64

+ Hostname string

+ Labels []string

+ PasswordHash string

+ Pid int

+ Version int

+ Wid string

+ type Dialer interface — windows/amd64

+ Dial func(network, addr string) (c net.Conn, err error)

+ type Failure struct — windows/amd64

+ Backtrace []string

+ ErrorMessage string

+ ErrorType string

+ FailedAt string

+ NextAt string

+ RetryCount int

+ type Job struct — windows/amd64

+ Args []interface{}

+ At string

+ Backtrace int

+ CreatedAt string

+ Custom map[string]interface{}

+ EnqueuedAt string

+ Failure *Failure

+ Jid string

+ Queue string

+ ReserveFor int

+ Retry int

+ Type string

+ func NewJob(jobtype string, args ...interface{}) *Job

+ func (j *Job) GetCustom(name string) (interface{}, bool)

+ func (j *Job) SetCustom(name string, value interface{}) *Job

+ func (j *Job) SetExpiresAt(expiresAt time.Time) *Job

+ func (j *Job) SetUniqueFor(secs uint) *Job

+ func (j *Job) SetUniqueness(until UniqueUntil) *Job

+ type JobFilter struct — windows/amd64

+ Jids []string

+ Jobtype string

+ Regexp string

+ func Matching(pattern string) JobFilter

+ func OfType(jobtype string) JobFilter

+ func WithJids(jids ...string) JobFilter

+ func (jf JobFilter) Matching(pattern string) JobFilter

+ func (jf JobFilter) OfType(jobtype string) JobFilter

+ func (jf JobFilter) WithJids(jids ...string) JobFilter

+ type JobTrack struct — windows/amd64

+ Description string

+ Jid string

+ Percent int

+ State string

+ UpdatedAt string

+ type MutateClient interface — windows/amd64

+ Clear func(name Structure) error

+ Discard func(name Structure, filter JobFilter) error

+ Kill func(name Structure, filter JobFilter) error

+ Requeue func(name Structure, filter JobFilter) error

+ type Operation struct — windows/amd64

+ Cmd string

+ Filter *JobFilter

+ Target Structure

+ type Pool struct — windows/amd64

+ func NewPool(capacity int) (*Pool, error)

+ func NewPoolWithDialer(capacity int, dialer Dialer) (*Pool, error)

+ func (p *Pool) Get() (*Client, error)

+ func (p *Pool) Put(client *Client)

+ func (p *Pool) With(fn func(conn *Client) error) error

+ type ProtocolError struct — windows/amd64

+ func (pe *ProtocolError) Error() string

+ type Server struct — windows/amd64

+ Address string

+ Network string

+ Password string

+ TLS *tls.Config

+ Timeout time.Duration

+ func DefaultServer() *Server

+ func (s *Server) Open() (*Client, error)

+ func (s *Server) OpenWithDialer(dialer Dialer) (*Client, error)

+ func (s *Server) ReadFromEnv() error

+ type Structure string — windows/amd64

+ const Dead

+ const Retries

+ const Scheduled

+ type UniqueUntil string — windows/amd64

+ const UntilStart

+ const UntilSuccess

Mar 1, 2021

Changes in this version

+ const ExpectedProtocolVersion — darwin/amd64, js/wasm, linux/amd64

+ var BatchAlreadyCommitted = fmt.Errorf("Batch has already been committed, must reopen") — darwin/amd64, js/wasm, linux/amd64

+ var BatchNotOpen = fmt.Errorf("Batch must be opened before it can be used") — darwin/amd64, js/wasm, linux/amd64

+ var Everything = JobFilter — darwin/amd64, js/wasm, linux/amd64

+ var Labels = []string — darwin/amd64, js/wasm, linux/amd64

+ var License = "GPLv3" — darwin/amd64, js/wasm, linux/amd64

+ var Licensing = "Licensed under the GNU Public License 3.0" — darwin/amd64, js/wasm, linux/amd64

+ var Name = "Faktory" — darwin/amd64, js/wasm, linux/amd64

+ var RandomProcessWid = "" — darwin/amd64, js/wasm, linux/amd64

+ var Version = "1.5.0" — darwin/amd64, js/wasm, linux/amd64

+ func RandomJid() string — darwin/amd64, js/wasm, linux/amd64

+ func RssKb() int64 — darwin/amd64, linux/amd64

+ type Batch struct — darwin/amd64, js/wasm, linux/amd64

+ Bid string

+ Complete *Job

+ Description string

+ ParentBid string

+ Success *Job

+ func NewBatch(cl *Client) *Batch

+ func (b *Batch) Commit() error

+ func (b *Batch) Jobs(fn func() error) error

+ func (b *Batch) Push(job *Job) error

+ type BatchStatus struct — darwin/amd64, js/wasm, linux/amd64

+ Bid string

+ CompleteState string

+ CreatedAt string

+ Description string

+ Failed int64

+ ParentBid string

+ Pending int64

+ SuccessState string

+ Total int64

+ type Client struct — darwin/amd64, js/wasm, linux/amd64

+ Location string

+ Options *ClientData

+ func Dial(srv *Server, password string) (*Client, error)

+ func DialWithDialer(srv *Server, password string, dialer Dialer) (*Client, error)

+ func Open() (*Client, error)

+ func OpenWithDialer(dialer Dialer) (*Client, error)

+ func (c *Client) Ack(jid string) error

+ func (c *Client) BatchCommit(bid string) error

+ func (c *Client) BatchNew(def *Batch) (*Batch, error)

+ func (c *Client) BatchOpen(bid string) (*Batch, error)

+ func (c *Client) BatchStatus(bid string) (*BatchStatus, error)

+ func (c *Client) Beat(args ...string) (string, error)

+ func (c *Client) Clear(name Structure) error

+ func (c *Client) Close() error

+ func (c *Client) Discard(name Structure, filter JobFilter) error

+ func (c *Client) Fail(jid string, err error, backtrace []byte) error

+ func (c *Client) Fetch(q ...string) (*Job, error)

+ func (c *Client) Flush() error

+ func (c *Client) Generic(cmdline string) (string, error)

+ func (c *Client) Info() (map[string]interface{}, error)

+ func (c *Client) Kill(name Structure, filter JobFilter) error

+ func (c *Client) PauseQueues(names ...string) error

+ func (c *Client) Push(job *Job) error

+ func (c *Client) Requeue(name Structure, filter JobFilter) error

+ func (c *Client) ResumeQueues(names ...string) error

+ func (c *Client) TrackGet(jid string) (*JobTrack, error)

+ func (c *Client) TrackSet(jid string, percent int, desc string, reserveUntil *time.Time) error

+ type ClientData struct — darwin/amd64, js/wasm, linux/amd64

+ Hostname string

+ Labels []string

+ PasswordHash string

+ Pid int

+ Version int

+ Wid string

+ type Dialer interface — darwin/amd64, js/wasm, linux/amd64

+ Dial func(network, addr string) (c net.Conn, err error)

+ type Failure struct — darwin/amd64, js/wasm, linux/amd64

+ Backtrace []string

+ ErrorMessage string

+ ErrorType string

+ FailedAt string

+ NextAt string

+ RetryCount int

+ type Job struct — darwin/amd64, js/wasm, linux/amd64

+ Args []interface{}

+ At string

+ Backtrace int

+ CreatedAt string

+ Custom map[string]interface{}

+ EnqueuedAt string

+ Failure *Failure

+ Jid string

+ Queue string

+ ReserveFor int

+ Retry int

+ Type string

+ func NewJob(jobtype string, args ...interface{}) *Job

+ func (j *Job) GetCustom(name string) (interface{}, bool)

+ func (j *Job) SetCustom(name string, value interface{}) *Job

+ func (j *Job) SetExpiresAt(expiresAt time.Time) *Job

+ func (j *Job) SetUniqueFor(secs uint) *Job

+ func (j *Job) SetUniqueness(until UniqueUntil) *Job

+ type JobFilter struct — darwin/amd64, js/wasm, linux/amd64

+ Jids []string

+ Jobtype string

+ Regexp string

+ func Matching(pattern string) JobFilter

+ func OfType(jobtype string) JobFilter

+ func WithJids(jids ...string) JobFilter

+ func (jf JobFilter) Matching(pattern string) JobFilter

+ func (jf JobFilter) OfType(jobtype string) JobFilter

+ func (jf JobFilter) WithJids(jids ...string) JobFilter

+ type JobTrack struct — darwin/amd64, js/wasm, linux/amd64

+ Description string

+ Jid string

+ Percent int

+ State string

+ UpdatedAt string

+ type MutateClient interface — darwin/amd64, js/wasm, linux/amd64

+ Clear func(name Structure) error

+ Discard func(name Structure, filter JobFilter) error

+ Kill func(name Structure, filter JobFilter) error

+ Requeue func(name Structure, filter JobFilter) error

+ type Operation struct — darwin/amd64, js/wasm, linux/amd64

+ Cmd string

+ Filter *JobFilter

+ Target Structure

+ type Pool struct — darwin/amd64, js/wasm, linux/amd64

+ func NewPool(capacity int) (*Pool, error)

+ func NewPoolWithDialer(capacity int, dialer Dialer) (*Pool, error)

+ func (p *Pool) Get() (*Client, error)

+ func (p *Pool) Put(client *Client)

+ func (p *Pool) With(fn func(conn *Client) error) error

+ type ProtocolError struct — darwin/amd64, js/wasm, linux/amd64

+ func (pe *ProtocolError) Error() string

+ type Server struct — darwin/amd64, js/wasm, linux/amd64

+ Address string

+ Network string

+ Password string

+ TLS *tls.Config

+ Timeout time.Duration

+ func DefaultServer() *Server

+ func (s *Server) Open() (*Client, error)

+ func (s *Server) OpenWithDialer(dialer Dialer) (*Client, error)

+ func (s *Server) ReadFromEnv() error

+ type Structure string — darwin/amd64, js/wasm, linux/amd64

+ const Dead

+ const Retries

+ const Scheduled

+ type UniqueUntil string — darwin/amd64, js/wasm, linux/amd64

+ const UntilStart

+ const UntilSuccess