com.dinstone.beanstalkc

接口 JobConsumer

所有已知子接口:

BeanstalkClient

public interface JobConsumer

JobConsumer is a kind of client beanstalk, that is responsible for the consumer job.

版本:

1.0.0.2013-4-15

作者:

guojf

方法概要

限定符和类型	方法和说明
boolean	buryJob(long id, int priority) The bury command puts a job into the "buried" state.
void	close() close the current connection and release resources. that's status is closed, and is no longer available.
boolean	deleteJob(long id) The delete command removes a job from the server entirely.
boolean	releaseJob(long id, int priority, int delay) The release command puts a reserved job back into the ready queue (and marks its state as "ready") to be run by any client.
Job	reserveJob(long timeout) beanstalkd will wait to send a response until one becomes available.
boolean	touchJob(long id) The "touch" command allows a worker to request more time to work on a job.

方法详细资料

reserveJob

Job reserveJob(long timeout)

beanstalkd will wait to send a response until one becomes available. Once a job is reserved for the client, the client has limited time to run (TTR) the job before the job times out. When the job times out, the server will put the job back into the ready queue. Both the TTR and the actual time left can be found in response to the stats-job command. A timeout value of 0 will cause the server to immediately return either a response or TIMED_OUT. A positive value of timeout will limit the amount of time the client will block on the reserve request until a job becomes available.

参数:

timeout - if timeout >= 0, then with reserve-with-timeout command.

返回:

deleteJob

boolean deleteJob(long id)

The delete command removes a job from the server entirely. It is normally used by the client when the job has successfully run to completion. A client can delete jobs that it has reserved, ready jobs, delayed jobs, and jobs that are buried.

参数:

id - is the job id to delete.

返回:

releaseJob

boolean releaseJob(long id,
                   int priority,
                   int delay)

The release command puts a reserved job back into the ready queue (and marks its state as "ready") to be run by any client. It is normally used when the job fails because of a transitory error.

参数:

id - is the job id to release.

priority - is a new priority to assign to the job.

delay - is an integer number of seconds to wait before putting the job in the ready queue. The job will be in the "delayed" state during this time.

返回:

buryJob

boolean buryJob(long id,
                int priority)

The bury command puts a job into the "buried" state. Buried jobs are put into a FIFO linked list and will not be touched by the server again until a client kicks them with the "kick" command.

参数:

id - is the job id to bury.

priority - is a new priority to assign to the job.

返回:

touchJob

boolean touchJob(long id)

The "touch" command allows a worker to request more time to work on a job. This is useful for jobs that potentially take a long time, but you still want the benefits of a TTR pulling a job away from an unresponsive worker. A worker may periodically tell the server that it's still alive and processing a job (e.g. it may do this on DEADLINE_SOON).

参数:

id - is the ID of a job reserved by the current connection.

返回:

close

void close()

close the current connection and release resources. that's status is closed, and is no longer available.