Scheduler

java.lang.Object
- kilim.Scheduler

Direct Known Subclasses:

AffineScheduler, ForkJoinScheduler
```
public abstract class Scheduler
extends java.lang.Object
```
This is a basic FIFO Executor. It maintains a list of runnable tasks and hands them out to WorkerThreads. Note that we don't maintain a list of all tasks, but we will at some point when we introduce monitoring/watchdog services. Paused tasks are not GC'd because their PauseReasons ought to be registered with some other live object.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Scheduler.Logger

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Scheduler.Logger`

Field Summary

Fields
Modifier and Type	Field and Description
`static Scheduler.Logger`	`defaultLogger`
`static int`	`defaultNumberThreads`
`static Scheduler`	`defaultScheduler`
`static Scheduler`	`pinnableScheduler`
`protected java.util.concurrent.atomic.AtomicBoolean`	`shutdown`

Constructor Summary

Constructors
Constructor and Description

Scheduler()

Constructors
Constructor and Description
`Scheduler()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected static Task`	`getCurrentTask()`
`static Scheduler`	`getDefaultPinnable()` get and possibly instantiate a scheduler that is pinnable
`static Scheduler`	`getDefaultScheduler()` get and possibly instantiate a default scheduler
`protected Scheduler`	`getPinnable()`
`abstract void`	`idledown()` block the thread till a moment at which all scheduled tasks have completed and then shutdown the scheduler does not prevent scheduling new tasks (from other threads) until the shutdown is complete so such a task could be partially executed
`abstract boolean`	`isEmptyish()` are the queues empty allows false positives, but not false negatives ie, if this method returns false, then at some moment during the call at least one queue was non-empty if it returns true then for each queue there was a moment during the call when it was empty
`boolean`	`isPinnable()`
`boolean`	`isShutdown()`
`protected void`	`log(java.lang.Object src, java.lang.Object obj)` write to the log
`protected static void`	`logRelay(Scheduler sched, java.lang.Object src, java.lang.Object obj)` a static accessor to allow log to be protected
`static Scheduler`	`make(int numThreads)` return a new default Scheduler with default queue length
`abstract int`	`numThreads()`
`abstract void`	`schedule(int index, Task t)` schedule a task to run
`void`	`schedule(Task t)` Schedule a task to run.
`abstract void`	`scheduleTimer(Timer t)`
`protected static void`	`setCurrentTask(Task t)`
`static void`	`setDefaultPinnable(Scheduler s)`
`static void`	`setDefaultScheduler(Scheduler s)`
`void`	`setLogger(Scheduler.Logger logger)` set a logger
`void`	`shutdown()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - defaultScheduler
```
public static volatile Scheduler defaultScheduler
```
  - pinnableScheduler
```
public static volatile Scheduler pinnableScheduler
```
  - defaultNumberThreads
```
public static int defaultNumberThreads
```
  - defaultLogger
```
public static Scheduler.Logger defaultLogger
```
  - shutdown
```
protected java.util.concurrent.atomic.AtomicBoolean shutdown
```
- Constructor Detail
  - Scheduler
```
public Scheduler()
```
- Method Detail
  - getCurrentTask
```
protected static Task getCurrentTask()
```
  - setCurrentTask
```
protected static void setCurrentTask(Task t)
```
  - make
```
public static Scheduler make(int numThreads)
```
    return a new default Scheduler with default queue length
    
    Parameters:
    
    numThreads - the number of threads to use, or use the default if less than one
    
    Returns:
    
    the new Scheduler
  - isEmptyish
```
public abstract boolean isEmptyish()
```
    are the queues empty allows false positives, but not false negatives ie, if this method returns false, then at some moment during the call at least one queue was non-empty if it returns true then for each queue there was a moment during the call when it was empty
  - numThreads
```
public abstract int numThreads()
```
  - isPinnable
```
public boolean isPinnable()
```
  - schedule
```
public void schedule(Task t)
```
    Schedule a task to run. It is the task's job to ensure that it is not scheduled when it is runnable. the default index for assignment to an executor
  - schedule
```
public abstract void schedule(int index,
                              Task t)
```
    schedule a task to run
    
    Parameters:
    
    index - the index of the executor to use, or less than zero to use the default (round robin) assignment
    
    t - the task
  - scheduleTimer
```
public abstract void scheduleTimer(Timer t)
```
  - idledown
```
public abstract void idledown()
```
    block the thread till a moment at which all scheduled tasks have completed and then shutdown the scheduler does not prevent scheduling new tasks (from other threads) until the shutdown is complete so such a task could be partially executed
  - shutdown
```
public void shutdown()
```
  - isShutdown
```
public boolean isShutdown()
```
  - logRelay
```
protected static void logRelay(Scheduler sched,
                               java.lang.Object src,
                               java.lang.Object obj)
```
    a static accessor to allow log to be protected
  - log
```
protected void log(java.lang.Object src,
                   java.lang.Object obj)
```
    write to the log
    
    Parameters:
    
    src - the source of the log object
    
    obj - the object to log
  - setLogger
```
public void setLogger(Scheduler.Logger logger)
```
    set a logger
    
    Parameters:
    
    logger - the logger
  - getDefaultScheduler
```
public static Scheduler getDefaultScheduler()
```
    get and possibly instantiate a default scheduler
  - getDefaultPinnable
```
public static Scheduler getDefaultPinnable()
```
    get and possibly instantiate a scheduler that is pinnable
  - getPinnable
```
protected Scheduler getPinnable()
```
  - setDefaultScheduler
```
public static void setDefaultScheduler(Scheduler s)
```
  - setDefaultPinnable
```
public static void setDefaultPinnable(Scheduler s)
```

Class Scheduler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

defaultScheduler

pinnableScheduler

defaultNumberThreads

defaultLogger

shutdown

Constructor Detail

Scheduler

Method Detail

getCurrentTask

setCurrentTask

make

isEmptyish

numThreads

isPinnable

schedule

schedule

scheduleTimer

idledown

shutdown

isShutdown

logRelay

log

setLogger

getDefaultScheduler

getDefaultPinnable

getPinnable

setDefaultScheduler

setDefaultPinnable