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

Class SocPS<J extends SimJob,Q extends SocPS>

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.processorsharing.AbstractProcessorSharingSimQueue<J,Q>

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

Type Parameters:

J - The type of SimJobs supported.

Q - The type of SimQueues supported.

All Implemented Interfaces:

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

public class SocPS<J extends SimJob,Q extends SocPS>
extends AbstractProcessorSharingSimQueue<J,Q>

The single-server "social processor-sharing" queue serves jobs in the service area simultaneously such that they all depart at the same time, distributing its service capacity to that effect.

At each time, the service rate of a job in the service area is linearly proportional to its remaining service time. (Note that this specification is actually essential; one can achieve simultaneous departures in many ways!)

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 Map<J,Double>	remainingServiceTime The per-job (in the service area) remaining service time.
static double	TOLERANCE_RST The tolerance for rounding errors in the remaining service time.

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
SocPS(org.javades.jsimulation.r5.SimEventList eventList) Creates a single-server SocPS queue with infinite buffer size given an event list.

Method Summary

Modifier and Type	Method and Description
SocPS<J,Q>	getCopySimQueue() Returns a new SocPS object on the same SimEventList.
Object	getQoS() Calls super method (in order to make implementation final).
Class	getQoSClass() Calls super method (in order to make implementation final).
protected double	getRemainingWork() Gets the total remaining work, i.e., the sum of remaining service times of all jobs in the service area.
protected double	getServiceTimeForJob(J job) Calls super method (in order to make implementation final).
protected void	insertJobInQueueUponArrival(J job, double time) Does nothing, and makes that final.
protected void	insertJobInQueueUponStart(J job, double time) Performs sanity checks and administers the job's initial remaining service time.
boolean	isStartArmed() Returns true.
protected void	removeJobFromQueueUponDeparture(J departingJob, double time) Calls removeJobFromQueueUponRevokation(J, double, boolean) for the departed job.
protected void	removeJobFromQueueUponDrop(J job, double time) Throws IllegalStateException.
protected void	removeJobFromQueueUponRevokation(J job, double time, boolean auto) Removes the jobs from the internal data structures.
protected void	rescheduleAfterArrival(J job, double time) Starts the arrived job if server-access credits are available.
protected void	rescheduleAfterDeparture(J departedJob, double time) Makes sure all jobs left in the service area depart as well (through recursion).
protected void	rescheduleAfterDrop(J job, double time) Throws IllegalStateException.
protected void	rescheduleAfterRevokation(J job, double time, boolean auto) Calls rescheduleDepartureEvent().
protected void	rescheduleAfterStart(J job, double time) Invokes rescheduleDepartureEvent().
protected void	rescheduleDepartureEvent() Reschedules the single departure event for this queue.
protected void	rescheduleForNewServerAccessCredits(double time) Starts jobs as long as there are server-access credits and jobs waiting.
protected void	resetEntitySubClass() Calls super method and clears the internal administration.
protected void	setServerAccessCreditsSubClass() Calls super method (in order to make implementation final).
String	toStringDefault() Returns "SocPS".
protected void	updateRemainingServiceTimes(double newTime) Updates the internal administration (i.c., remaining service times) for executing jobs in the service area.

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

queueAccessVacationDropSubClass

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

TOLERANCE_RST

public static final double TOLERANCE_RST

The tolerance for rounding errors in the remaining service time.

See Also:

Constant Field Values

remainingServiceTime

protected final Map<J extends SimJob,Double> remainingServiceTime

The per-job (in the service area) remaining service time.

Not intended to be modified by sub-classes!

Constructor Detail

SocPS

public SocPS(org.javades.jsimulation.r5.SimEventList eventList)

Creates a single-server SocPS queue with infinite buffer size given an event list.

The constructor registers a pre-update hook that maintains the remaining service times.

Parameters:

eventList - The event list to use.

See Also:

AbstractSimEntity.registerPreUpdateHook(java.util.function.DoubleConsumer), updateRemainingServiceTimes(double)

Method Detail

getCopySimQueue

public SocPS<J,Q> getCopySimQueue()

Returns a new SocPS object on the same SimEventList.

Returns:

A new SocPS object on the same SimEventList.

See Also:

AbstractSimEntity.getEventList()

toStringDefault

public String toStringDefault()

Returns "SocPS".

Specified by:

toStringDefault in interface SimEntity

Overrides:

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

Returns:

"SocPS".

See Also:

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

getQoSClass

public final Class getQoSClass()

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

Returns:

The Java class used for QoS behavior, may be null.

getQoS

public final Object getQoS()

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

Returns:

The QoS value, may be null.

getRemainingWork

protected final double getRemainingWork()

Gets the total remaining work, i.e., the sum of remaining service times of all jobs in the service area.

Returns:

The total remaining work, non-negative.

See Also:

remainingServiceTime

resetEntitySubClass

protected final void resetEntitySubClass()

Calls super method and clears the internal administration.

Overrides:

resetEntitySubClass in class AbstractSimQueue<J extends SimJob,Q extends SocPS>

See Also:

remainingServiceTime

updateRemainingServiceTimes

protected final void updateRemainingServiceTimes(double newTime)

Updates the internal administration (i.c., remaining service times) for executing jobs in the service area.

This method is called as an pre-update hook, and not meant to be called from user code (in sub-classes). It is left protected for javadoc.

Parameters:

newTime - The new time.

See Also:

AbstractSimQueue.hasJobsInServiceArea(), AbstractSimEntity.getLastUpdateTime(), remainingServiceTime, AbstractSimEntity.registerPreUpdateHook(java.util.function.DoubleConsumer)

insertJobInQueueUponArrival

protected final void insertJobInQueueUponArrival(J job,
                                                 double time)

Does nothing, and makes that final.

Specified by:

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

Parameters:

job - The job that arrived.

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

See Also:

AbstractSimQueue.arrive(double, J)

rescheduleAfterArrival

protected final void rescheduleAfterArrival(J job,
                                            double time)

Starts the arrived job if server-access credits are available.

Specified by:

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

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:

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

removeJobFromQueueUponDrop

protected final void removeJobFromQueueUponDrop(J job,
                                                double time)

Throws IllegalStateException.

Specified by:

removeJobFromQueueUponDrop in class AbstractSimQueue<J extends SimJob,Q extends SocPS>

Parameters:

job - The job that is to be dropped.

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

Throws:

IllegalStateException - Always, as this SimQueue does not drop jobs.

See Also:

AbstractSimQueue.drop(J, double)

rescheduleAfterDrop

protected final void rescheduleAfterDrop(J job,
                                         double time)

Throws IllegalStateException.

Specified by:

rescheduleAfterDrop in class AbstractSimQueue<J extends SimJob,Q extends SocPS>

Parameters:

job - The jobs that was dropped.

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

Throws:

IllegalStateException - Always, as this SimQueue does not drop jobs.

See Also:

AbstractSimQueue.drop(J, double)

removeJobFromQueueUponRevokation

protected final void removeJobFromQueueUponRevokation(J job,
                                                      double time,
                                                      boolean auto)

Removes the jobs from the internal data structures.

Removes the job remainingServiceTime.

Specified by:

removeJobFromQueueUponRevokation in class AbstractSimQueue<J extends SimJob,Q extends SocPS>

Parameters:

job - The job that is to be revoked.

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

auto - Whether or not this applies to an auto-revocation.

See Also:

AbstractSimQueue.revoke(double, J, boolean), AbstractSimQueue.autoRevoke(double, J), remainingServiceTime, rescheduleAfterRevokation(J, double, boolean)

rescheduleAfterRevokation

protected final void rescheduleAfterRevokation(J job,
                                               double time,
                                               boolean auto)

Calls rescheduleDepartureEvent().

Specified by:

rescheduleAfterRevokation in class AbstractSimQueue<J extends SimJob,Q extends SocPS>

Parameters:

job - The jobs that was successfully revoked.

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

auto - Whether or not this applies to an auto-revocation.

See Also:

AbstractSimQueue.revoke(double, J, boolean), AbstractSimQueue.autoRevoke(double, J), rescheduleDepartureEvent(), removeJobFromQueueUponRevokation(J, double, boolean)

setServerAccessCreditsSubClass

protected final void setServerAccessCreditsSubClass()

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

Overrides:

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

See Also:

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

rescheduleForNewServerAccessCredits

protected final void rescheduleForNewServerAccessCredits(double time)

Starts jobs as long as there are server-access credits and jobs waiting.

Specified by:

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

Parameters:

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

See Also:

AbstractSimQueue.hasServerAcccessCredits(), AbstractSimQueue.hasJobsInWaitingArea(), AbstractSimQueue.start(double, J), AbstractSimQueue.getFirstJobInWaitingArea()

isStartArmed

public final boolean isStartArmed()

Returns true.

Returns:

True.

See Also:

SimQueueListener.notifyNewStartArmed(double, Q, boolean)

insertJobInQueueUponStart

protected final void insertJobInQueueUponStart(J job,
                                               double time)

Performs sanity checks and administers the job's initial remaining service time.

Specified by:

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

Parameters:

job - The job that starts.

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

See Also:

getServiceTimeForJob(J), remainingServiceTime

rescheduleAfterStart

protected final void rescheduleAfterStart(J job,
                                          double time)

Invokes rescheduleDepartureEvent().

Specified by:

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

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:

rescheduleDepartureEvent(), insertJobInQueueUponStart(J, double)

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 SocPS>

Parameters:

job - The job, non-null.

Returns:

The result from the super method.

removeJobFromQueueUponDeparture

protected final void removeJobFromQueueUponDeparture(J departingJob,
                                                     double time)

Calls removeJobFromQueueUponRevokation(J, double, boolean) for the departed job.

Specified by:

removeJobFromQueueUponDeparture in class AbstractSimQueue<J extends SimJob,Q extends SocPS>

Parameters:

departingJob - The job that departs.

time - The departure (current) time.

See Also:

removeJobFromQueueUponRevokation(J, double, boolean), rescheduleAfterDeparture(J, double)

rescheduleAfterDeparture

protected final void rescheduleAfterDeparture(J departedJob,
                                              double time)

Makes sure all jobs left in the service area depart as well (through recursion).

All jobs in the service area depart simultaneously, if at all. Hence, if a job departs, all other jobs in the service area must depart as well. The main scheduling method, rescheduleDepartureEvent(), schedules (or invokes) a departure through AbstractSimQueue.depart(double, J) on a single job, and it is up to us to make sure all jobs in the service area depart.

Specified by:

rescheduleAfterDeparture in class AbstractSimQueue<J extends SimJob,Q extends SocPS>

Parameters:

departedJob - The departed job.

time - The departure (current) time.

See Also:

removeJobFromQueueUponDeparture(J, double)

rescheduleDepartureEvent

protected final void rescheduleDepartureEvent()

Reschedules the single departure event for this queue.

First, this method cancels any pending departure event.

If the remaining work of this queue is negligible, in view of TOLERANCE_RST, or if the remaining work is finite but time is negative of positive infinity, this method triggers the departure of all jobs in the service area, if any, by invoking AbstractSimQueue.depart(double, J) on the first job in the service area, relying on the departure handling for the other jobs to depart.

Otherwise, if the remaining work is finite and time is finite, this method schedules a suitable departure event through AbstractSimQueue.scheduleDepartureEvent(double, J) for the first job in the service area, if present, again relying on the departure handling for the simultaneous departure of the other jobs in the service area.

Otherwise, the remaining work is infinite (or there are no jobs) and nothing needs to be done.

See Also:

AbstractSimQueue.getDepartureEvents(), AbstractSimQueue.cancelDepartureEvent(org.javades.jqueues.r5.entity.jq.SimJQEvent.Departure<J, Q>), AbstractSimEntity.getLastUpdateTime(), getRemainingWork(), AbstractSimQueue.hasJobsInServiceArea(), AbstractSimQueue.getNumberOfJobsInServiceArea(), AbstractSimQueue.depart(double, J), AbstractSimQueue.hasJobsInServiceArea(), TOLERANCE_RST, AbstractSimQueue.scheduleDepartureEvent(double, J)