com.birbit.android.jobqueue.scheduling

Class Scheduler

java.lang.Object

com.birbit.android.jobqueue.scheduling.Scheduler

Direct Known Subclasses:

BatchingScheduler

public abstract class Scheduler
extends java.lang.Object

This class handles communication and tracking with a scheduler that can wake up the app / job manager based on external events.

JobManager will call attached scheduler every time it thinks that the app should be waken up for the given job. Each request comes with a SchedulerConstraint which should be reported back to the JobManager when the system service wakes it up.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Scheduler.Callback Internal class that handles the communication between the JobManager and the scheduler

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Scheduler()

Method Summary

Modifier and Type	Method and Description
abstract void	cancelAll() When called, should cancel all pending jobs
void	init(android.content.Context context, Scheduler.Callback callback)
abstract void	onFinished(SchedulerConstraint constraint, boolean reschedule) Called by the JobManager when a scheduled constraint is handled.
abstract void	request(SchedulerConstraint constraint)
boolean	start(SchedulerConstraint constraint) Triggers the JobManager to handle the given constraint.
boolean	stop(SchedulerConstraint constraint)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Scheduler

protected Scheduler()

Method Detail

init

public void init(android.content.Context context,
                 Scheduler.Callback callback)

request

public abstract void request(SchedulerConstraint constraint)

start

public final boolean start(SchedulerConstraint constraint)

Triggers the JobManager to handle the given constraint. JobManager always call onFinished(SchedulerConstraint, boolean) with an async callback.

Parameters:

constraint - The constraint

Returns:

true if there is work to do be done, false otherwise

stop

public final boolean stop(SchedulerConstraint constraint)

onFinished

public abstract void onFinished(SchedulerConstraint constraint,
                                boolean reschedule)

Called by the JobManager when a scheduled constraint is handled.

Parameters:

constraint - The original constraint

reschedule - True if the job should be rescheduled

cancelAll

public abstract void cancelAll()

When called, should cancel all pending jobs