JobQueue (Javadocs [I2P+ 2.13.0+] - API Version 0.9.70+)

java.lang.Object
- net.i2p.router.JobQueue

```
public class JobQueue
extends Object
```
Prioritizes and executes router jobs with preference for earlier scheduled tasks. Manages job queues, timing, and thread pool execution for router-internal operations only. For use by the router only. Not to be used by applications or plugins.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static String`	`PROP_MAX_RUNNERS` router.config parameter to override the max runners
`(package private) static int`	`RUNNERS` How many when we go parallel

Constructor Summary
Constructors
Constructor and Description
JobQueue(RouterContext context)
Does not start the pumper.

Constructors
Constructor and Description
`JobQueue(RouterContext context)` Does not start the pumper.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addJob(Job job)` Enqueue the specified job for normal processing.
`void`	`addJobToTop(Job job)` Enqueue the specified job to be processed at the top of the queue.
`(package private) void`	`addRunners(int count)` Add additional job runners to the pool.
`void`	`allowParallelOperation()` Enable parallel job execution and start additional queue runner threads.
`int`	`getActiveRunnerCount()` Current number of active job runners.
`int`	`getAndResetDroppedCount()` Dropped jobs count (resets on read).
`long`	`getAvgLag()` Average lag time for jobs waiting in the queue.
`int`	`getJobs(Collection<Job> readyJobs, Collection<Job> timedJobs, Collection<Job> activeJobs, Collection<Job> justFinishedJobs)` Collect statistics about jobs currently in the queue.
`Collection<JobStats>`	`getJobStats()` All job statistics collected by the queue.
`Job`	`getLastJob()` Last job that was executed.
`long`	`getLastJobBegin()` Timestamp of when the last job began execution.
`long`	`getLastJobEnd()` Timestamp of when the last job finished execution.
`long`	`getMaxActiveJobDuration()` Maximum duration of currently running jobs.
`long`	`getMaxLag()` Maximum lag time for jobs waiting in the queue.
`int`	`getMaxRunnerCount()` Current maximum number of job runners allowed.
`(package private) Job`	`getNext()` Next job in queue.
`int`	`getReadyCount()` Number of jobs ready to be executed.
`int`	`getReadyTestJobCount()` Count TestJob instances that are ready to run or currently running (excluding future-scheduled timed jobs).
`int`	`getTestJobCount()` Count the number of TestJob instances currently queued in the job queue.
`(package private) boolean`	`isAlive()` Check if the job queue is currently alive and processing jobs.
`void`	`releaseJobRunners(int count, String reason)` Release previously requested job runners.
`(package private) int`	`removeIdleRunners(int maxToRemove)` Remove idle job runners from the pool.
`void`	`removeJob(Job job)` Remove a job from the job queue.
`(package private) void`	`removeRunner(int id)` Remove a queue runner from the registry.
`void`	`requestJobRunners(int count, String reason, long autoReleaseMs)` Request additional job runners for an anticipated burst.
`void`	`runQueue(int numThreads)` Start the job queue with the specified number of runner threads.
`(package private) void`	`shutdown()` Shutdown the job queue, stopping all runners and clearing all jobs.
`void`	`startup()` Initialize and start the job queue pumper thread.
`(package private) void`	`updateStats(Job job, long doStart, long _origStartAfter, long duration)` Update stats

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

- Field Detail
  - PROP_MAX_RUNNERS
```
static final String PROP_MAX_RUNNERS
```
    router.config parameter to override the max runners
    See Also:
    Constant Field Values
  - RUNNERS
```
static int RUNNERS
```
    How many when we go parallel
- Constructor Detail
  - JobQueue
```
public JobQueue(RouterContext context)
```
    Does not start the pumper. Caller MUST call startup.
- Method Detail
  - addJob
```
public void addJob(Job job)
```
    Enqueue the specified job for normal processing.
    Parameters:
    job - job to add to the queue
  - addJobToTop
```
public void addJobToTop(Job job)
```
    Enqueue the specified job to be processed at the top of the queue. This is a high-priority job that will be run before any normal-priority jobs.
    Parameters:
    job - job to add to the front of the queue
  - addRunners
```
void addRunners(int count)
```
    Add additional job runners to the pool. Package-private for use by JobQueueScaler.
    Parameters:
    count - the number of runners to add
  - allowParallelOperation
```
public void allowParallelOperation()
```
    Enable parallel job execution and start additional queue runner threads. After calling this, multiple jobs may execute concurrently.
  - getActiveRunnerCount
```
public int getActiveRunnerCount()
```
    Current number of active job runners. Package-private for use by JobQueueScaler.
    Returns:
    the number of active runners
  - getAndResetDroppedCount
```
public int getAndResetDroppedCount()
```
    Dropped jobs count (resets on read).
    Returns:
    number of jobs dropped since last call
  - getAvgLag
```
public long getAvgLag()
```
    Average lag time for jobs waiting in the queue. This is the average delay between when jobs were supposed to start and the current time across all ready jobs.
    Returns:
    average lag in milliseconds, or 0 if queue is empty
  - getJobs
```
public int getJobs(Collection<Job> readyJobs,
                   Collection<Job> timedJobs,
                   Collection<Job> activeJobs,
                   Collection<Job> justFinishedJobs)
```
    Collect statistics about jobs currently in the queue. This includes jobs that are ready, timed, active, and just finished.
    Parameters:
    readyJobs - collection to populate with ready jobs
    timedJobs - collection to populate with timed/scheduled jobs
    activeJobs - collection to populate with currently running jobs
    justFinishedJobs - collection to populate with recently finished jobs
    Returns:
    the number of queue runners currently active
  - getJobStats
```
public Collection<JobStats> getJobStats()
```
    All job statistics collected by the queue.
    Returns:
    unmodifiable collection of JobStats for all job types
  - getLastJob
```
public Job getLastJob()
```
    Last job that was executed.
    Returns:
    the last Job that was executed, or null if no jobs have run
  - getLastJobBegin
```
public long getLastJobBegin()
```
    Timestamp of when the last job began execution.
    Returns:
    timestamp in milliseconds when the last job started, or -1 if no jobs have run
  - getLastJobEnd
```
public long getLastJobEnd()
```
    Timestamp of when the last job finished execution.
    Returns:
    timestamp in milliseconds when the last job ended, or -1 if no jobs have run
  - getMaxActiveJobDuration
```
public long getMaxActiveJobDuration()
```
    Maximum duration of currently running jobs. This measures how long active jobs have been executing, which is important when all runners are busy but queue is empty.
    Returns:
    max duration in milliseconds of any currently running job, or 0 if no jobs running
  - getMaxLag
```
public long getMaxLag()
```
    Maximum lag time for jobs waiting in the queue. This is the delay between when the earliest job was supposed to start and the current time.
    Returns:
    maximum lag in milliseconds, or 0 if queue is empty
  - getMaxRunnerCount
```
public int getMaxRunnerCount()
```
    Current maximum number of job runners allowed. Returns the RAM-adjusted limit if scaler is active and RAM is constrained, otherwise returns the hard limit (2× configured).
    Returns:
    the current effective maximum runner limit
  - getNext
```
Job getNext()
```
    Next job in queue.
  - getReadyCount
```
public int getReadyCount()
```
    Number of jobs ready to be executed.
    Returns:
    count of ready jobs in normal, high priority, and timed-ready queues
  - getReadyTestJobCount
```
public int getReadyTestJobCount()
```
    Count TestJob instances that are ready to run or currently running (excluding future-scheduled timed jobs). Used by the scaler to determine whether TestJobs are dominating runner resources right now.
    Returns:
    the number of ready/active TestJob instances
  - getTestJobCount
```
public int getTestJobCount()
```
    Count the number of TestJob instances currently queued in the job queue. This includes both ready jobs and timed jobs waiting to be executed.
    Returns:
    the total number of TestJob instances in the queue
  - isAlive
```
boolean isAlive()
```
    Check if the job queue is currently alive and processing jobs.
    Returns:
    true if the queue is alive and running
  - releaseJobRunners
```
public void releaseJobRunners(int count,
                              String reason)
```
    Release previously requested job runners.
    Parameters:
    count - number of runners to release
    reason - must match the reason used in requestJobRunners
  - removeIdleRunners
```
int removeIdleRunners(int maxToRemove)
```
    Remove idle job runners from the pool. Package-private for use by JobQueueScaler. Only removes runners that are not currently processing a job.
    Parameters:
    maxToRemove - the maximum number of runners to remove
    Returns:
    the number of runners actually removed
  - removeJob
```
public void removeJob(Job job)
```
    Remove a job from the job queue.
    Parameters:
    job - the job to remove from the queue
  - removeRunner
```
void removeRunner(int id)
```
    Remove a queue runner from the registry. Package-private for use by JobQueueRunner.
    Parameters:
    id - the runner ID to remove
  - requestJobRunners
```
public void requestJobRunners(int count,
                              String reason,
                              long autoReleaseMs)
```
    Request additional job runners for an anticipated burst. Delegates to JobQueueScaler for tracking and auto-decay.
    Parameters:
    count - number of additional runners to reserve
    reason - label for logging and tracking
    autoReleaseMs - if > 0, auto-decay after this many ms
  - runQueue
```
public void runQueue(int numThreads)
```
    Start the job queue with the specified number of runner threads. Does nothing if parallel operation is not enabled and runners already exist.
    Parameters:
    numThreads - the number of runner threads to start
  - shutdown
```
void shutdown()
```
    Shutdown the job queue, stopping all runners and clearing all jobs.
  - startup
```
public void startup()
```
    Initialize and start the job queue pumper thread. Does not start the job runner threads.
  - updateStats
```
void updateStats(Job job,
                 long doStart,
                 long _origStartAfter,
                 long duration)
```
    Update stats

Class JobQueue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_MAX_RUNNERS

RUNNERS

Constructor Detail

JobQueue

Method Detail

addJob

addJobToTop

addRunners

allowParallelOperation

getActiveRunnerCount

getAndResetDroppedCount

getAvgLag

getJobs

getJobStats

getLastJob

getLastJobBegin

getLastJobEnd

getMaxActiveJobDuration

getMaxLag

getMaxRunnerCount

getNext

getReadyCount

getReadyTestJobCount

getTestJobCount

isAlive

releaseJobRunners

removeIdleRunners

removeJob

removeRunner

requestJobRunners

runQueue

shutdown

startup

updateStats