org.javades.jqueues.r5.entity.jq.queue.qos

Class PQ<J extends SimJob,Q extends PQ,P extends Comparable>

java.lang.Object

org.javades.jqueues.r5.entity.AbstractSimEntity

org.javades.jqueues.r5.entity.jq.AbstractSimJQ<J,Q>

org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue<J,Q>

org.javades.jqueues.r5.entity.jq.queue.AbstractClassicSimQueue<J,Q>

org.javades.jqueues.r5.entity.jq.queue.preemptive.AbstractPreemptiveSimQueue<J,Q>

org.javades.jqueues.r5.entity.jq.queue.qos.AbstractPreemptiveSimQueueQoS<J,Q,P>

org.javades.jqueues.r5.entity.jq.queue.qos.PQ<J,Q,P>

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

P - The type used for QoS.

All Implemented Interfaces:

SimQueue<J,Q>, SimQoS<J,Q>, SimEntity, SimQueueOrJobQoS<J,Q,P>, SimQueueQoS<J,Q,P>, org.javades.jsimulation.r5.SimEventListResetListener

public class PQ<J extends SimJob,Q extends PQ,P extends Comparable>
extends AbstractPreemptiveSimQueueQoS<J,Q,P>

The Priority-Queueing queueing discipline with a single server and infinite buffer size.

Author:

Jan de Jongh, TNO

Copyright (C) 2005-2017 Jan de Jongh, TNO

This file is covered by the LICENSE file in the root of this project.

Nested Class Summary

Nested classes/interfaces inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

AbstractSimEntity.Notifier, AbstractSimEntity.PreNotificationHook

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

SimQueue.AutoRevocationPolicy

Nested classes/interfaces inherited from interface org.javades.jqueues.r5.entity.SimEntity

SimEntity.Action, SimEntity.UnknownNotificationTypePolicy, SimEntity.UnknownOperationPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected NavigableMap<P,Set<J>>	jobsQoSMap

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.preemptive.AbstractPreemptiveSimQueue

DEFAULT_PREEMPTION_STRATEGY, jobsBeingServed, remainingServiceTime, TOLERANCE_RST

Fields inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

eventsScheduled, SANITY

Fields inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

USE_ARRAY_OPTIMIZATION

Constructor Summary

Constructors

Constructor and Description
PQ(org.javades.jsimulation.r5.SimEventList eventList, PreemptionStrategy preemptionStrategy, Class<P> qosClass, P defaultJobQoS) Creates a Priority Queue with infinite buffer size and a single server, given an event list, preemption strategy, and QoS structure.

Method Summary

Modifier and Type	Method and Description
PQ<J,Q,P>	getCopySimQueue() Returns a new PQ object on the same SimEventList with the same preemption strategy and QoS structure.
protected J	getExecutableJobWithHighestPriority() Gets the job (if any) eligible for execution that has highest priority, respecting server-access credits.
NavigableMap<P,Set<J>>	getJobsQoSMap() Gets the mapping QoS values onto jobs currently visiting this queue with that particular QoS value.
protected double	getServiceTimeForJob(J job) Calls super method (in order to make implementation final).
protected void	insertJobInQueueUponArrival(J job, double time) Inserts the job into jobsQoSMap.
protected void	insertJobInQueueUponStart(J job, double time) Updates AbstractPreemptiveSimQueue.remainingServiceTime.
boolean	isStartArmed() Returns true if there are no jobs present in the service area.
protected void	removeJobFromQueueUponExit(J exitingJob, double time) Removes the job from internal administration and cancels a pending departure event for it.
protected void	reschedule() Reschedules through assessment of which job to serve.
protected void	rescheduleAfterArrival(J job, double time) Starts the arrived job immediately if it is the executable job (respecting server-access credits) with highest priority.
protected void	rescheduleAfterExit(double time) Invokes reschedule().
protected void	rescheduleAfterStart(J job, double time) Invokes reschedule().
protected void	rescheduleForNewServerAccessCredits(double time) Invokes reschedule().
protected void	resetEntitySubClass() Calls super method and clear jobsQoSMap.
protected void	setServerAccessCreditsSubClass() Calls super method (in order to make implementation final).
String	toStringDefault() Returns "PQ[preemption strategy]".

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.qos.AbstractPreemptiveSimQueueQoS

getDefaultJobQoS, getQoS, getQoSClass, setQoS, setQoSClass

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.preemptive.AbstractPreemptiveSimQueue

getJobsBeingServed, getPreemptionStrategy, preemptJob, queueAccessVacationDropSubClass, removeJobFromQueueUponDeparture, removeJobFromQueueUponDrop, removeJobFromQueueUponRevokation, rescheduleAfterDeparture, rescheduleAfterDrop, rescheduleAfterRevokation, startServiceChunk, updateRemainingServiceTime

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractClassicSimQueue

getBufferSize, getNumberOfServers

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.AbstractSimQueue

arrive, autoRevoke, cancelDepartureEvent, cancelDepartureEvent, depart, departureFromEventList, drop, getAutoRevocationPolicy, getDepartureEvents, getDepartureEvents, getFirstJob, getFirstJobInServiceArea, getFirstJobInWaitingArea, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, hasJobs, hasJobsInServiceArea, hasJobsInWaitingArea, hasServerAcccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, registerStdOutSimQueueListener, revoke, revoke, scheduleDepartureEvent, scheduleJobArrival, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits, start, takeServerAccessCredit, triggerPotentialNewStartArmed, unregisterStdOutSimQueueListener

Methods inherited from class org.javades.jqueues.r5.entity.AbstractSimEntity

addPendingNotification, addPendingNotification, clearAndUnlockPendingNotificationsIfLocked, delegateOperation, doAfterNotifications, doOperation, fireAndLockPendingNotifications, getEventList, getLastUpdateTime, getRegisteredDelegatedOperations, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, notifyEventListReset, registerDelegatedOperation, registerNotificationType, registerOperation, registerPreEventHook, registerPreNotificationHook, registerPreUpdateHook, registerSimEntityListener, registerStdOutSimEntityListener, removeDelegationForOperation, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, toString, unregisterSimEntityListener, unregisterStdOutSimEntityListener, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.javades.jqueues.r5.entity.jq.queue.SimQueue

arrive, getAutoRevocationPolicy, getJobs, getJobsInServiceArea, getJobsInWaitingArea, getNumberOfJobs, getNumberOfJobsInServiceArea, getNumberOfJobsInWaitingArea, getServerAccessCredits, isJob, isJobInServiceArea, isJobInWaitingArea, isQueueAccessVacation, revoke, revoke, setAutoRevocationPolicy, setQueueAccessVacation, setServerAccessCredits

Methods inherited from interface org.javades.jqueues.r5.entity.SimEntity

doAfterNotifications, doOperation, getEventList, getLastUpdateTime, getRegisteredNotificationTypes, getRegisteredOperations, getSimEntityListeners, getUnknownNotificationTypePolicy, getUnknownOperationPolicy, isIgnoreEventListReset, registerSimEntityListener, resetEntity, setIgnoreEventListReset, setName, setUnknownNotificationTypePolicy, setUnknownOperationPolicy, unregisterSimEntityListener, update

Methods inherited from interface org.javades.jsimulation.r5.SimEventListResetListener

notifyEventListReset

Field Detail

jobsQoSMap

protected final NavigableMap<P extends Comparable,Set<J extends SimJob>> jobsQoSMap

Constructor Detail

PQ

public PQ(org.javades.jsimulation.r5.SimEventList eventList,
          PreemptionStrategy preemptionStrategy,
          Class<P> qosClass,
          P defaultJobQoS)

Creates a Priority Queue with infinite buffer size and a single server, given an event list, preemption strategy, and QoS structure.

Parameters:

eventList - The event list to use.

preemptionStrategy - The preemption strategy, if null, the default is used (preemptive-resume).

qosClass - The Java class to use for QoS behavior, non-null.

defaultJobQoS - The default QoS value to use for non-QoS jobs, non-null.

Throws:

IllegalArgumentException - If the event list or one or both QoS arguments is null.

Method Detail

getCopySimQueue

public PQ<J,Q,P> getCopySimQueue()

Returns a new PQ object on the same SimEventList with the same preemption strategy and QoS structure.

Returns:

A new PQ object on the same SimEventList with the same preemption strategy and QoS structure.

See Also:

AbstractSimEntity.getEventList(), AbstractPreemptiveSimQueue.getPreemptionStrategy(), AbstractPreemptiveSimQueueQoS.getQoSClass(), AbstractPreemptiveSimQueueQoS.getDefaultJobQoS()

toStringDefault

public String toStringDefault()

Returns "PQ[preemption strategy]".

Specified by:

toStringDefault in interface SimEntity

Overrides:

toStringDefault in class AbstractSimQueue<J extends SimJob,Q extends PQ>

Returns:

"PQ[preemption strategy]".

See Also:

SimEntity.setName(java.lang.String), Object.toString()

getJobsQoSMap

public final NavigableMap<P,Set<J>> getJobsQoSMap()

Description copied from interface: SimQueueQoS

Gets the mapping QoS values onto jobs currently visiting this queue with that particular QoS value.

Each SimJob present returning (valid) non-null QoS value from SimQoS.getQoS() must be in present in only that value set, and the union of these value sets must exactly match SimQueue.getJobs(). Jobs returning null from SimQoS.getQoS() must be put in a value set corresponding to SimQueueQoS.getDefaultJobQoS().

Note that many concrete subclasses will impose an ordering on the keys and/or on the value sets.

Returns:

The mapping QoS values onto jobs currently visiting this queue with that particular QoS value.

See Also:

SimQueue.getJobs(), SimQoS.getQoS(), SimQueueQoS.getDefaultJobQoS()

resetEntitySubClass

protected final void resetEntitySubClass()

Calls super method and clear jobsQoSMap.

Overrides:

resetEntitySubClass in class AbstractPreemptiveSimQueueQoS<J extends SimJob,Q extends PQ,P extends Comparable>

See Also:

jobsQoSMap

insertJobInQueueUponArrival

protected final void insertJobInQueueUponArrival(J job,
                                                 double time)

Inserts the job into jobsQoSMap.

Specified by:

insertJobInQueueUponArrival in class AbstractSimQueue<J extends SimJob,Q extends PQ>

Parameters:

job - The job that arrived.

time - The current time (i.e., arrival time of the job).

See Also:

SimQueueQoSUtils.getAndCheckJobQoS(J, Q)

rescheduleAfterArrival

protected final void rescheduleAfterArrival(J job,
                                            double time)

Starts the arrived job immediately if it is the executable job (respecting server-access credits) with highest priority.

Specified by:

rescheduleAfterArrival in class AbstractSimQueue<J extends SimJob,Q extends PQ>

Parameters:

job - The job that arrived (and is already present in AbstractSimQueue.getJobs()).

time - The current time (i.e., the arrival time of the job).

See Also:

getExecutableJobWithHighestPriority(), AbstractSimQueue.start(double, J)

setServerAccessCreditsSubClass

protected final void setServerAccessCreditsSubClass()

Calls super method (in order to make implementation final).

Overrides:

setServerAccessCreditsSubClass in class AbstractSimQueue<J extends SimJob,Q extends PQ>

See Also:

AbstractSimQueue.getServerAccessCredits(), AbstractSimQueue.setServerAccessCredits(double, int), AbstractSimQueue.rescheduleForNewServerAccessCredits(double)

rescheduleForNewServerAccessCredits

protected final void rescheduleForNewServerAccessCredits(double time)

Invokes reschedule().

Specified by:

rescheduleForNewServerAccessCredits in class AbstractSimQueue<J extends SimJob,Q extends PQ>

Parameters:

time - The current time (i.e., the time at which new server-access credits became available).

See Also:

AbstractSimQueue.setServerAccessCredits(double, int), AbstractSimQueue.hasServerAcccessCredits()

isStartArmed

public final boolean isStartArmed()

Returns true if there are no jobs present in the service area.

Returns:

True if there are no jobs present in the service area.

See Also:

AbstractSimQueue.getNumberOfJobsInServiceArea()

insertJobInQueueUponStart

protected final void insertJobInQueueUponStart(J job,
                                               double time)

Updates AbstractPreemptiveSimQueue.remainingServiceTime.

Specified by:

insertJobInQueueUponStart in class AbstractSimQueue<J extends SimJob,Q extends PQ>

Parameters:

job - The job that starts.

time - The current time (i.e., start time of the job).

See Also:

getServiceTimeForJob(J), AbstractPreemptiveSimQueue.remainingServiceTime

rescheduleAfterStart

protected final void rescheduleAfterStart(J job,
                                          double time)

Invokes reschedule().

Specified by:

rescheduleAfterStart in class AbstractSimQueue<J extends SimJob,Q extends PQ>

Parameters:

job - The job that started (and is already present in AbstractSimQueue.getJobsInServiceArea().

time - The current time (i.e., the start time of the job).

See Also:

AbstractPreemptiveSimQueue.remainingServiceTime, reschedule()

getServiceTimeForJob

protected final double getServiceTimeForJob(J job)

Calls super method (in order to make implementation final).

Overrides:

getServiceTimeForJob in class AbstractSimQueue<J extends SimJob,Q extends PQ>

Parameters:

job - The job, non-null.

Returns:

The result from the super method.

removeJobFromQueueUponExit

protected final void removeJobFromQueueUponExit(J exitingJob,
                                                double time)

Removes the job from internal administration and cancels a pending departure event for it.

Specified by:

removeJobFromQueueUponExit in class AbstractPreemptiveSimQueue<J extends SimJob,Q extends PQ>

Parameters:

exitingJob - The job leaving.

time - The (current) time.

See Also:

AbstractPreemptiveSimQueue.remainingServiceTime, AbstractPreemptiveSimQueue.jobsBeingServed, AbstractSimQueue.getDepartureEvents(), AbstractSimQueue.cancelDepartureEvent(org.javades.jqueues.r5.entity.jq.SimJQEvent.Departure<J, Q>), SimQueueQoSUtils.getAndCheckJobQoS(J, Q), getJobsQoSMap()

rescheduleAfterExit

protected final void rescheduleAfterExit(double time)

Invokes reschedule().

Specified by:

rescheduleAfterExit in class AbstractPreemptiveSimQueue<J extends SimJob,Q extends PQ>

Parameters:

time - The (current) time.

See Also:

AbstractPreemptiveSimQueue.rescheduleAfterDrop(J, double), AbstractPreemptiveSimQueue.rescheduleAfterRevokation(J, double, boolean), AbstractPreemptiveSimQueue.rescheduleAfterDeparture(J, double), AbstractPreemptiveSimQueue.removeJobFromQueueUponExit(J, double), AbstractPreemptiveSimQueue.startServiceChunk(double, J)

getExecutableJobWithHighestPriority

protected final J getExecutableJobWithHighestPriority()

Gets the job (if any) eligible for execution that has highest priority, respecting server-access credits.

This method effectively determines the job that should be in service in PQ by examining (solely) AbstractSimQueue.getJobs(), jobsQoSMap, AbstractSimQueue.getJobsInServiceArea(), and AbstractSimQueue.hasServerAcccessCredits().

Note that ties between executable jobs with equal QoS values are broken by the order in which the jobs appear in an iterator over the applicable value set in jobsQoSMap (in the obvious sense that the job that first appears in the iterator is given highest priority).

This method does (some) sanity checks on jobsQoSMap on the fly.

Returns:

The job (if any) eligible for execution that has highest priority, respecting server-access credits; null if there is no such job.

reschedule

protected final void reschedule()

Reschedules through assessment of which job to serve.

Repeatedly (until they match) confronts the job to serve as obtained through getExecutableJobWithHighestPriority() with the job currently in service (the only job in AbstractPreemptiveSimQueue.jobsBeingServed). If there is a mismatch, and if there is a job currently being served, it preempts the latter job through AbstractPreemptiveSimQueue.preemptJob(double, J), and recurs. Otherwise, if there is a mismatch but no job is currently being served, it starts getExecutableJobWithHighestPriority() either by AbstractSimQueue.start(double, J) if the job is not already in the service area, or by AbstractPreemptiveSimQueue.startServiceChunk(double, J) otherwise.

See Also:

AbstractPreemptiveSimQueue.jobsBeingServed, getExecutableJobWithHighestPriority(), AbstractPreemptiveSimQueue.preemptJob(double, J), AbstractSimQueue.isJobInServiceArea(org.javades.jqueues.r5.entity.jq.job.SimJob), AbstractSimQueue.start(double, J), AbstractPreemptiveSimQueue.startServiceChunk(double, J)