org.javades.jqueues.r5.entity.jq.queue.composite.parallel

Class JSQ<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends JSQ>

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.composite.AbstractSimQueueComposite<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite_LocalStart<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.parallel.AbstractParallelSimQueues<DJ,DQ,J,Q>

org.javades.jqueues.r5.entity.jq.queue.composite.parallel.JSQ<DJ,DQ,J,Q>

Type Parameters:

DJ - The delegate-job type.

DQ - The queue-type for delegate jobs.

J - The job type.

Q - The queue type for jobs.

All Implemented Interfaces:

SimQueueComposite<DJ,DQ,J,Q>, SimQueueSelector<J,DQ>, SimQueue<J,Q>, SimQoS<J,Q>, SimEntity, SimEntityListener, org.javades.jsimulation.r5.SimEventListResetListener

public class JSQ<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends JSQ>
extends AbstractParallelSimQueues<DJ,DQ,J,Q>

Parallel queues with Join Shortest Queue selection policy.

The selection of the "shortest queue" is either based on all jobs present in the candidate queues or on all waiting jobs present.

Ties are broken at random with equal probabilities.

This queue uses the LocalStart model as explained with AbstractSimQueueComposite_LocalStart.

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.

See Also:

SimQueue.getNumberOfJobs(), SimQueue.getNumberOfJobsInServiceArea()

Nested Class Summary

Nested classes/interfaces inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.AbstractSimQueueComposite

AbstractSimQueueComposite.RealDelegateJobMapper<J extends SimJob,DJ extends SimJob>

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.composite.AbstractSimQueueComposite

realDelegateJobMapper

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
JSQ(org.javades.jsimulation.r5.SimEventList eventList, Set<DQ> queues, DelegateSimJobFactory delegateSimJobFactory, boolean onlyWaitingJobs, Random rng) Creates a parallel queue with Join-Shortest Queue selection policy given an event list and a list of queues.

Method Summary

Modifier and Type	Method and Description
JSQ<DJ,DQ,J,Q>	getCopySimQueue() Returns a new JSQ object on the same SimEventList with copies of the sub-queues, the same onlyWaitingJobs argument, a new RNG, and the same delegate-job factory.
static SimQueue	getRandomSimQueueFromSet(Set<SimQueue> queues, Random rng) Selects a queue at random (with equal probabilities) from a set of queues.
boolean	isOnlyWaitingJobs() Returns whether only waiting jobs are considered in queue selection.
protected void	resetEntitySubClass() Calls super method (in order to make implementation final).
String	toStringDefault() Returns "JSQ[queue list]".

Methods inherited from class org.javades.jqueues.r5.entity.jq.queue.composite.parallel.AbstractParallelSimQueues

processSubQueueNotifications

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

getQoS, getQoSClass, getServiceTimeForJob, insertJobInQueueUponArrival, insertJobInQueueUponStart, isStartArmed, queueAccessVacationDropSubClass, removeJobFromQueueUponDeparture, removeJobFromQueueUponDrop, removeJobFromQueueUponRevokation, rescheduleAfterArrival, rescheduleAfterDeparture, rescheduleAfterDrop, rescheduleAfterRevokation, rescheduleAfterStart, rescheduleForNewServerAccessCredits, setServerAccessCreditsSubClass

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

addRealJobLocal, getCopySimQueues, getCopySubSimQueues, getDelegateJob, getDelegateJobMild, getDelegateSimJobFactory, getIndex, getIndex, getQueue, getQueue, getQueues, getRealJob, getRealJob, getSimQueueSelector, isDelegateJob, isRealJob, notifyResetEntity, notifyStateChanged, notifyUpdate, removeJobsFromQueueLocal, resetSimQueueSelector, selectFirstQueue, selectNextQueue, setDelegateSimJobFactory

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

JSQ

public JSQ(org.javades.jsimulation.r5.SimEventList eventList,
           Set<DQ> queues,
           DelegateSimJobFactory delegateSimJobFactory,
           boolean onlyWaitingJobs,
           Random rng)

Creates a parallel queue with Join-Shortest Queue selection policy given an event list and a list of queues.

Parameters:

eventList - The event list to use.

queues - The queues in no particular order.

delegateSimJobFactory - An optional factory for the delegate SimJobs.

onlyWaitingJobs - Whether queue-length is the number of waiting jobs (true), or the total number of jobs present (true).

rng - An optional user-supplied random-number generator (if absent, a new one is created for local use).

Throws:

IllegalArgumentException - If the event list is null, the queues argument is null, or if it contains a null entry.

See Also:

DelegateSimJobFactory, DefaultDelegateSimJobFactory, SimQueueSelector, SimQueue.getNumberOfJobs(), SimQueue.getNumberOfJobsInServiceArea(), Random

Method Detail

getCopySimQueue

public JSQ<DJ,DQ,J,Q> getCopySimQueue()

Returns a new JSQ object on the same SimEventList with copies of the sub-queues, the same onlyWaitingJobs argument, a new RNG, and the same delegate-job factory.

Returns:

A new JSQ object on the same SimEventList with copies of the sub-queues, the same onlyWaitingJobs argument, a new RNG, and the same delegate-job factory.

Throws:

UnsupportedOperationException - If the encapsulated queues could not be copied through SimQueue.getCopySimQueue().

See Also:

AbstractSimEntity.getEventList(), AbstractSimQueueComposite.getCopySubSimQueues(), AbstractSimQueueComposite.getDelegateSimJobFactory(), isOnlyWaitingJobs()

toStringDefault

public String toStringDefault()

Returns "JSQ[queue list]".

Specified by:

toStringDefault in interface SimEntity

Overrides:

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

Returns:

"JSQ[queue list]".

See Also:

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

isOnlyWaitingJobs

public final boolean isOnlyWaitingJobs()

Returns whether only waiting jobs are considered in queue selection.

Returns:

True if only waiting jobs are considered in queue selection, false if all jobs present are considered.

getRandomSimQueueFromSet

public static SimQueue getRandomSimQueueFromSet(Set<SimQueue> queues,
                                                Random rng)

Selects a queue at random (with equal probabilities) from a set of queues.

Parameters:

queues - The queues, non-null.

rng - The random-number generator to use, non-null.

Returns:

A random member in the set, or null if the set was empty.

Throws:

IllegalArgumentException - If the queues argument is null, contains null, or the rng argument is null.

resetEntitySubClass

protected final void resetEntitySubClass()

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

Overrides:

resetEntitySubClass in class AbstractSimQueueComposite_LocalStart<DJ extends AbstractSimJob,DQ extends SimQueue,J extends SimJob,Q extends JSQ>

See Also:

AbstractSimQueueComposite_LocalStart.removeJobFromQueueUponRevokation(J, double, boolean), AbstractSimQueueComposite_LocalStart.rescheduleAfterRevokation(J, double, boolean), SimEntity.resetEntity()