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

Class PS<J extends SimJob,Q extends PS>

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

org.javades.jqueues.r5.entity.jq.queue.processorsharing.PS<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 PS<J extends SimJob,Q extends PS>
extends AbstractEgalitarianProcessorSharingSimQueue<J,Q>

The single-server PS queue serves all jobs simultaneously, equally distributing its service capacity.

Processor Sharing.

The (Egalitarian) Processor-Sharing queueing system distributes its service capacity equally among the jobs in execution. Jobs start immediately upon arrival, provided that there are server-access credits left. Upon regaining server-access credits, jobs are started in arrival order.

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 inherited from class org.javades.jqueues.r5.entity.jq.queue.processorsharing.AbstractEgalitarianProcessorSharingSimQueue

virtualDepartureTime

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

Method Summary

Modifier and Type	Method and Description
PS<J,Q>	getCopySimQueue() Returns a new PS 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 void	insertJobInQueueUponArrival(J job, double time) Does nothing, and makes that final.
boolean	isStartArmed() Returns true.
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) Calls super method (in order to make implementation final).
protected void	rescheduleAfterDrop(J job, double time) Throws IllegalStateException.
protected void	rescheduleAfterRevokation(J job, double time, boolean auto) Calls AbstractEgalitarianProcessorSharingSimQueue.rescheduleDepartureEvent().
protected void	rescheduleForNewServerAccessCredits(double time) Starts jobs in arrival order as long as there are server-access credits and jobs waiting.
protected void	resetEntitySubClass() Calls super method (in order to make implementation final).
protected void	setServerAccessCreditsSubClass() Calls super method (in order to make implementation final).
String	toStringDefault() Returns "PS".

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

getServiceTimeForJob, getVirtualTime, insertJobInQueueUponStart, removeJobFromQueueUponDeparture, rescheduleAfterStart, rescheduleDepartureEvent, updateVirtualTime

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

Constructor Detail

PS

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

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

Parameters:

eventList - The event list to use.

Method Detail

getCopySimQueue

public PS<J,Q> getCopySimQueue()

Returns a new PS object on the same SimEventList.

Returns:

A new PS object on the same SimEventList.

See Also:

AbstractSimEntity.getEventList()

toStringDefault

public String toStringDefault()

Returns "PS".

Specified by:

toStringDefault in interface SimEntity

Overrides:

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

Returns:

"PS".

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.

resetEntitySubClass

protected final void resetEntitySubClass()

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

Overrides:

resetEntitySubClass in class AbstractEgalitarianProcessorSharingSimQueue<J extends SimJob,Q extends PS>

See Also:

SimEntity.resetEntity()

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

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

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), insertJobInQueueUponArrival(J, double)

removeJobFromQueueUponDrop

protected final void removeJobFromQueueUponDrop(J job,
                                                double time)

Throws IllegalStateException.

Specified by:

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

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

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 AbstractEgalitarianProcessorSharingSimQueue.virtualDepartureTime.

Specified by:

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

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)

rescheduleAfterRevokation

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

Calls AbstractEgalitarianProcessorSharingSimQueue.rescheduleDepartureEvent().

Specified by:

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

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:

AbstractEgalitarianProcessorSharingSimQueue.rescheduleDepartureEvent()

setServerAccessCreditsSubClass

protected final void setServerAccessCreditsSubClass()

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

Overrides:

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

See Also:

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

rescheduleForNewServerAccessCredits

protected final void rescheduleForNewServerAccessCredits(double time)

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

Specified by:

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

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)

rescheduleAfterDeparture

protected final void rescheduleAfterDeparture(J departedJob,
                                              double time)

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

Overrides:

rescheduleAfterDeparture in class AbstractEgalitarianProcessorSharingSimQueue<J extends SimJob,Q extends PS>

Parameters:

departedJob - The departed job.

time - The departure (current) time.

See Also:

AbstractEgalitarianProcessorSharingSimQueue.rescheduleDepartureEvent(), AbstractEgalitarianProcessorSharingSimQueue.removeJobFromQueueUponDeparture(J, double)