com.microsoft.applicationinsights.internal.util

Class PeriodicTaskPool

java.lang.Object

com.microsoft.applicationinsights.internal.util.PeriodicTaskPool

All Implemented Interfaces:

Stoppable

public class PeriodicTaskPool
extends java.lang.Object
implements Stoppable

A class to execute tasks on a schedule. This class should be used to run and manage all the scheduled Tasks in SDK.

Usage example

Here is a class that uses PeriodicTaskManager to execute PeriodicTaskPool.PeriodicRunnableTask

 
 import com.microsoft.applicationinsights.internal.util.PeriodicTaskPool;
 public class BeeperControl {
     public void beepForHour() {
        final Runnable beeper = new Runnable() {
            public void run() { System.out.println("beep"); }
         };

         // create the PeriodicRunnableTask from runnable
         PeriodicTaskPool.PeriodicRunnableTask periodicTask = PeriodicTaskPool.PeriodicRunnableTask.getInstance(beeper,
                 0, 1, TimeUnit.SECONDS, PeriodicTaskManager.class,
                 "Beeper");
         ScheduledFuture<?> future = periodicTaskPool.executePeriodicRunnableTask(periodicTask);

         // Cancel the PeriodicRunnableTask
         PeriodicTaskManager.INSTANCE.cancelPeriodicTask(periodicTask);
     }
 }

Since:

2.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PeriodicTaskPool.PeriodicRunnableTask A Class that holds the instance of Runnable command along with it's unique taskId, initial delay, repetition period and TimeUnit of repetition period

Constructor Summary

Constructors

Constructor and Description
PeriodicTaskPool(int poolSize, java.lang.String poolName)

Method Summary

Modifier and Type	Method and Description
boolean	cancelPeriodicTask(PeriodicTaskPool.PeriodicRunnableTask task) Cancels the task, if it's running and removes it from the periodicTaskMap.
java.util.concurrent.ScheduledFuture<?>	executePeriodicRunnableTask(PeriodicTaskPool.PeriodicRunnableTask task) Executes a PeriodicTaskPool.PeriodicRunnableTask
void	stop(long timeout, java.util.concurrent.TimeUnit timeUnit)
void	stopAndClear() Stop all the tasks and removes them from the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodicTaskPool

public PeriodicTaskPool(int poolSize,
                        java.lang.String poolName)

Method Detail

executePeriodicRunnableTask

public java.util.concurrent.ScheduledFuture<?> executePeriodicRunnableTask(PeriodicTaskPool.PeriodicRunnableTask task)

Executes a PeriodicTaskPool.PeriodicRunnableTask

Parameters:

task - PeriodicRunnableTask

Returns:

ScheduledFuture associated with the scheduled task.

cancelPeriodicTask

public boolean cancelPeriodicTask(PeriodicTaskPool.PeriodicRunnableTask task)

Cancels the task, if it's running and removes it from the periodicTaskMap.

Parameters:

task - PeriodicRunnableTask

Returns:

true if task is cancelled successfully

stop

public void stop(long timeout,
                 java.util.concurrent.TimeUnit timeUnit)

Specified by:

stop in interface Stoppable

stopAndClear

public void stopAndClear()

Stop all the tasks and removes them from the collection.