com.birbit.android.jobqueue

Class BatchingScheduler

java.lang.Object

com.birbit.android.jobqueue.scheduling.Scheduler

com.birbit.android.jobqueue.BatchingScheduler

public class BatchingScheduler
extends Scheduler

JobManager calls scheduler every time it receives some job that can use the Scheduler APIs. This may get too noisy and unnecessary.

This BatchingScheduler wraps a generic scheduler and avoid calling the system service if a request is made that has the same criteria as the previous one.

Nested Class Summary

Nested classes/interfaces inherited from class com.birbit.android.jobqueue.scheduling.Scheduler

Scheduler.Callback

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_BATCHING_PERIOD_IN_MS

Constructor Summary

Constructors

Constructor and Description
BatchingScheduler(Scheduler delegate, Timer timer) Creates a scheduler that wraps another scheduler and batches similar jobs into a single request to minimize IPC.
BatchingScheduler(Scheduler delegate, Timer timer, long batchingDurationInMs) Creates a scheduler that wraps another scheduler and batches similar jobs into a single request to minimize IPC.

Method Summary

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

Methods inherited from class com.birbit.android.jobqueue.scheduling.Scheduler

start, stop

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BATCHING_PERIOD_IN_MS

public static final long DEFAULT_BATCHING_PERIOD_IN_MS

Constructor Detail

BatchingScheduler

public BatchingScheduler(Scheduler delegate,
                         Timer timer)

Creates a scheduler that wraps another scheduler and batches similar jobs into a single request to minimize IPC.

This constructor uses 15 minutes as the batching range.

Parameters:

delegate - The actual scheduler

timer - The Timer instance used by the JobManager

BatchingScheduler

public BatchingScheduler(Scheduler delegate,
                         Timer timer,
                         long batchingDurationInMs)

Creates a scheduler that wraps another scheduler and batches similar jobs into a single request to minimize IPC.

Parameters:

delegate - The actual scheduler

timer - The Timer instance used by the JobManager

batchingDurationInMs - Jobs whose criteria match and execution period is within this value will be merged into 1 request.

Method Detail

init

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

Overrides:

init in class Scheduler

request

public void request(SchedulerConstraint constraint)

Specified by:

request in class Scheduler

onFinished

public void onFinished(SchedulerConstraint constraint,
                       boolean reschedule)

Description copied from class: Scheduler

Called by the JobManager when a scheduled constraint is handled.

Specified by:

onFinished in class Scheduler

Parameters:

constraint - The original constraint

reschedule - True if the job should be rescheduled

cancelAll

public void cancelAll()

Description copied from class: Scheduler

When called, should cancel all pending jobs

Specified by:

cancelAll in class Scheduler