com.birbit.android.jobqueue

Interface JobQueue

All Known Implementing Classes:

CachedJobQueue, SimpleInMemoryPriorityQueue, SqliteJobQueue

public interface JobQueue

Interface that any JobQueue should implement These job queues can be given to JobManager.

Method Summary

Modifier and Type	Method and Description
void	clear() clear all jobs in the queue.
int	count() Returns the # of jobs that are waiting to be run
int	countReadyJobs(Constraint constraint) counts the # of jobs that can run now.
JobHolder	findJobById(java.lang.String id) returns the job with the given id if it exists in the queue
java.util.Set<JobHolder>	findJobs(Constraint constraint) Returns jobs that matches the given constraints
java.lang.Long	getNextJobDelayUntilNs(Constraint constraint) Returns when the next job should run (in nanoseconds), should return null if there are no jobs to run.
boolean	insert(JobHolder jobHolder) Inserts the given JobHolder.
boolean	insertOrReplace(JobHolder jobHolder) Does the same thing with insert but the only difference is that if job has an insertion ID, it should replace the existing one should also reset running session id to JobManager.NOT_RUNNING_SESSION_ID Is called when a job is re-added (due to exception during run)
JobHolder	nextJobAndIncRunCount(Constraint constraint) Returns the next available job in the data set It should also assign the sessionId as the RunningSessionId and persist that data if necessary.
void	onJobCancelled(JobHolder holder) Called when a job is cancelled by the user.
void	remove(JobHolder jobHolder) Removes the job from the data store.
void	substitute(JobHolder newJob, JobHolder oldJob) Remove the old job from the queue while inserting the new one.

Method Detail

insert

boolean insert(JobHolder jobHolder)

Inserts the given JobHolder.

Parameters:

jobHolder - The JobHolder to be inserted

Returns:

True if job is added, false otherwise

insertOrReplace

boolean insertOrReplace(JobHolder jobHolder)

Does the same thing with insert but the only difference is that if job has an insertion ID, it should replace the existing one should also reset running session id to JobManager.NOT_RUNNING_SESSION_ID Is called when a job is re-added (due to exception during run)

Parameters:

jobHolder - The JobHolder to be added

Returns:

True if job is added, false otherwise

substitute

void substitute(JobHolder newJob,
                JobHolder oldJob)

Remove the old job from the queue while inserting the new one.

Parameters:

newJob - To be inserted

oldJob - To be removed

remove

void remove(JobHolder jobHolder)

Removes the job from the data store. Is called after a job is completed (or cancelled)

Parameters:

jobHolder - The JobHolder to be removed

count

int count()

Returns the # of jobs that are waiting to be run

Returns:

The number of jobs that are waiting in the queue

countReadyJobs

int countReadyJobs(Constraint constraint)

counts the # of jobs that can run now. if there are more jobs from the same group, they are count as 1 since they cannot be run in parallel.

Exclude groups are guaranteed to be ordered in natural order.

Parameters:

constraint - The constraint to match the jobs

Returns:

The number of jobs that are ready to run

nextJobAndIncRunCount

JobHolder nextJobAndIncRunCount(Constraint constraint)

Returns the next available job in the data set It should also assign the sessionId as the RunningSessionId and persist that data if necessary. It should filter out all running jobs and exclude groups are guaranteed to be ordered in natural order

Parameters:

constraint - The constraint to match the job.

Returns:

The next job to be run that matches the constraint or null if there is no such job

getNextJobDelayUntilNs

java.lang.Long getNextJobDelayUntilNs(Constraint constraint)

Returns when the next job should run (in nanoseconds), should return null if there are no jobs to run.

This method should check both delayed jobs and jobs that require network with a timeout.

Parameters:

constraint - The constraint to match the job.

Returns:

The time until next job is ready or null if there aren't any jobs matching the constraint

clear

void clear()

clear all jobs in the queue. should probably be called when user logs out.

findJobById

JobHolder findJobById(java.lang.String id)

returns the job with the given id if it exists in the queue

Parameters:

id - id of the job

Returns:

JobHolder with the given id or null if it does not exists

findJobs

java.util.Set<JobHolder> findJobs(Constraint constraint)

Returns jobs that matches the given constraints

Parameters:

constraint - The constraint to match the job.

Returns:

The set of jobs that matches the given constraint

onJobCancelled

void onJobCancelled(JobHolder holder)

Called when a job is cancelled by the user.

It is important to not return this job from queries anymore.

Parameters:

holder - The JobHolder that is being cancelled