Documentation
¶
Index ¶
- type Disque
- func (d *Disque) Ack(jobID string) (err error)
- func (d *Disque) Close()
- func (d *Disque) Delete(jobID string) (err error)
- func (d *Disque) Fetch(queueName string, timeout time.Duration) (job *Job, err error)
- func (d *Disque) FetchMultiple(queueName string, count int, timeout time.Duration) (jobs []*Job, err error)
- func (d *Disque) GetJobDetails(jobID string) (jobDetails *JobDetails, err error)
- func (d *Disque) Initialize() (err error)
- func (d *Disque) Nack(jobID string) (err error)
- func (d *Disque) Push(queueName string, job string, timeout time.Duration) (jobID string, err error)
- func (d *Disque) PushWithOptions(queueName string, job string, timeout time.Duration, options map[string]string) (jobID string, err error)
- func (d *Disque) QueueLength(queueName string) (queueLength int, err error)
- type Job
- type JobDetails
- type Pool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Disque ¶
type Disque struct {
// contains filtered or unexported fields
}
Disque connection type
func (*Disque) Close ¶
func (d *Disque) Close()
Close the main connection maintained by this Disque instance
func (*Disque) FetchMultiple ¶
func (d *Disque) FetchMultiple(queueName string, count int, timeout time.Duration) (jobs []*Job, err error)
FetchMultiple will retrieve multiple jobs from a Disque queue.
func (*Disque) GetJobDetails ¶
func (d *Disque) GetJobDetails(jobID string) (jobDetails *JobDetails, err error)
GetJobDetails will retrieve details for an existing job
func (*Disque) Initialize ¶
Initialize the connection, including the exploration of nodes participating in the cluster.
func (*Disque) Push ¶
func (d *Disque) Push(queueName string, job string, timeout time.Duration) (jobID string, err error)
Push job onto a Disque queue with the default set of options
func (*Disque) PushWithOptions ¶
func (d *Disque) PushWithOptions(queueName string, job string, timeout time.Duration, options map[string]string) (jobID string, err error)
PushWithOptions pushes a job onto a Disque queue with options given in the options map
ADDJOB queue_name job <ms-timeout> [REPLICATE <count>] [DELAY <sec>] [RETRY <sec>] [TTL <sec>] [MAXLEN <count>] [ASYNC]
Example:
options := make(map[string]string)
options["DELAY"] = 30
options["ASYNC"] = true
d.PushWithOptions("queue_name", "job", 1*time.Second, options)
type Job ¶
type Job struct {
QueueName string
JobID string
Message string
Nacks int64
AdditionalDeliveries int64
}
Job represents a Disque job
type JobDetails ¶
type JobDetails struct {
JobID string
QueueName string
State string
ReplicationFactor int
TTL time.Duration
CreatedAt time.Time
Delay time.Duration
Retry time.Duration
Nacks int64
AdditionalDeliveries int64
NodesDelivered []string
NodesConfirmed []string
NextRequeueWithin time.Duration
NextAwakeWithin time.Duration
Message string
}
JobDetails contains details for a specific Disque job
type Pool ¶
type Pool struct {
// contains filtered or unexported fields
}
Pool represents a pool of Disque connections
func NewPool ¶
func NewPool(servers []string, cycle int, capacity int, maxCapacity int, idleTimeout time.Duration) (p *Pool)
NewPool creates a new pool of Disque connections. capacity is the number of active resources in the pool: there can be up to 'capacity' of these at a given time. maxCapacity specifies the extent to which the pool can be resized in the future through the SetCapacity function. You cannot resize the pool beyond maxCapacity. If a resource is unused beyond idleTimeout, it's discarded. An idleTimeout of 0 means that there is no timeout.
func (*Pool) Close ¶
func (p *Pool) Close()
Close empties the pool calling Close on all its resources. You can call Close while there are outstanding resources. It waits for all resources to be returned (Put). After a Close, Get is not allowed.
func (*Pool) Get ¶
Get will return the next available resource. If capacity has not been reached, it will create a new one using the factory. Otherwise, it will wait until the supplied context expires.
func (*Pool) Put ¶
Put will return a resource to the pool. For every successful Get, a corresponding Put is required. If you no longer need a resource, you will need to call Put(nil) instead of returning the closed resource. This will eventually cause a new resource to be created in its place.
func (*Pool) SetCapacity ¶
SetCapacity changes the capacity of the pool. You can use it to shrink or expand, but not beyond the max capacity. If the change requires the pool to be shrunk, SetCapacity waits till the necessary number of resources are returned to the pool. A SetCapacity of 0 is equivalent to closing the ResourcePool.
Source Files