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

Class GATE<J extends SimJob,Q extends GATE>

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

org.javades.jqueues.r5.entity.jq.queue.serverless.GATE<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, SimQueueWithGate<J,Q>, org.javades.jsimulation.r5.SimEventListResetListener

public class GATE<J extends SimJob,Q extends GATE>
extends AbstractServerlessSimQueue<J,Q>
implements SimQueueWithGate<J,Q>

The GATE queue lets jobs depart without service conditionally ("gate is open") or lets them wait ("gate is closed").

The gate status is a SimQueue state variable, i.e., it can be changed from an event list being run.

The state of the gate is represented by a single non-negative number, the gate passage credits. If the credits are zero, the gate is closed, and if infinite (Integer.MAX_VALUE), the gate is open without limits. If the number of credits is in between, the gate is also open, but only for that number of job passages.

This SimQueue is server-less.

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:

DROP, SINK, ZERO, DELAY

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.AbstractSimQueue

eventsScheduled, SANITY

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

USE_ARRAY_OPTIMIZATION

Constructor Summary

Constructors

Constructor and Description
GATE(org.javades.jsimulation.r5.SimEventList eventList) Creates a GATE queue with infinite buffer size given an event list.

Method Summary

Modifier and Type	Method and Description
GATE<J,Q>	getCopySimQueue() Returns a new GATE object on the same SimEventList.
int	getGatePassageCredits() Returns the number of (remaining) gate-passage credits.
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.
protected void	removeJobFromQueueUponDeparture(J departingJob, double time) Does nothing.
protected void	removeJobFromQueueUponDrop(J job, double time) Throws IllegalStateException.
protected void	removeJobFromQueueUponRevokation(J job, double time, boolean auto) Does nothing.
protected void	rescheduleAfterArrival(J job, double time) Makes the job depart from the job queue if the gate is currently open
protected void	rescheduleAfterDeparture(J departedJob, double time) Does nothing.
protected void	rescheduleAfterDrop(J job, double time) Throws IllegalStateException.
protected void	rescheduleAfterRevokation(J job, double time, boolean auto) Does nothing.
protected void	resetEntitySubClass() Calls super method and opens the gate (limitless).
void	setGatePassageCredits(double time, int gatePassageCredits) Updates the internal administration and releases (makes depart) waiting jobs if applicable.
String	toStringDefault() Returns "GATE".

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

getServiceTimeForJob, insertJobInQueueUponStart, isStartArmed, queueAccessVacationDropSubClass, rescheduleAfterStart, rescheduleForNewServerAccessCredits, setServerAccessCreditsSubClass

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, isStartArmed, 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

GATE

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

Creates a GATE queue with infinite buffer size given an event list.

Parameters:

eventList - The event list to use.

Method Detail

getCopySimQueue

public GATE<J,Q> getCopySimQueue()

Returns a new GATE object on the same SimEventList.

Specified by:

getCopySimQueue in interface SimQueue<J extends SimJob,Q extends GATE>

Returns:

A new GATE object on the same SimEventList.

See Also:

AbstractSimEntity.getEventList()

toStringDefault

public String toStringDefault()

Returns "GATE".

Specified by:

toStringDefault in interface SimEntity

Overrides:

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

Returns:

"GATE".

See Also:

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

getGatePassageCredits

public int getGatePassageCredits()

Description copied from interface: SimQueueWithGate

Returns the number of (remaining) gate-passage credits.

Specified by:

getGatePassageCredits in interface SimQueueWithGate<J extends SimJob,Q extends GATE>

Returns:

The number of (remaining) gate-passage credits.

setGatePassageCredits

public final void setGatePassageCredits(double time,
                                        int gatePassageCredits)

Updates the internal administration and releases (makes depart) waiting jobs if applicable.

This must be a top-level event, at the expense of a IllegalStateException.

Specified by:

setGatePassageCredits in interface SimQueueWithGate<J extends SimJob,Q extends GATE>

Parameters:

time - The current time.

gatePassageCredits - The remaining number of passages to allow (will override, not add to, any previous value), with Integer.MAX_VALUE treated as infinity.

See Also:

getGatePassageCredits(), AbstractSimEntity.update(double), AbstractSimQueue.hasJobsInWaitingArea(), AbstractSimQueue.depart(double, J), AbstractSimEntity.clearAndUnlockPendingNotificationsIfLocked(), AbstractSimEntity.fireAndLockPendingNotifications()

getQoSClass

public final Class getQoSClass()

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

Specified by:

getQoSClass in interface SimQoS<J extends SimJob,Q extends GATE>

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).

Specified by:

getQoS in interface SimQoS<J extends SimJob,Q extends GATE>

Returns:

The QoS value, may be null.

resetEntitySubClass

protected final void resetEntitySubClass()

Calls super method and opens the gate (limitless).

Overrides:

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

See Also:

SimEntity.resetEntity()

insertJobInQueueUponArrival

protected final void insertJobInQueueUponArrival(J job,
                                                 double time)

Does nothing.

Specified by:

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

Parameters:

job - The job that arrived.

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

See Also:

AbstractSimQueue.arrive(double, J), AbstractSimQueue.rescheduleAfterArrival(J, double)

rescheduleAfterArrival

protected final void rescheduleAfterArrival(J job,
                                            double time)

Makes the job depart from the job queue if the gate is currently open

Specified by:

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

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:

getGatePassageCredits(), AbstractSimQueue.depart(double, J)

removeJobFromQueueUponDrop

protected final void removeJobFromQueueUponDrop(J job,
                                                double time)

Throws IllegalStateException.

Specified by:

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

Parameters:

job - The job that is to be dropped.

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

Throws:

IllegalStateException - Always, as a call to this method is unexpected.

See Also:

AbstractSimQueue.drop(J, double), AbstractSimQueue.rescheduleAfterDrop(J, double)

rescheduleAfterDrop

protected final void rescheduleAfterDrop(J job,
                                         double time)

Throws IllegalStateException.

Specified by:

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

Parameters:

job - The jobs that was dropped.

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

Throws:

IllegalStateException - Always, as a call to this method is unexpected.

See Also:

AbstractSimQueue.drop(J, double), AbstractSimQueue.removeJobFromQueueUponDrop(J, double)

removeJobFromQueueUponRevokation

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

Does nothing.

Specified by:

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

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), AbstractSimQueue.rescheduleAfterRevokation(J, double, boolean), SimQueue.AutoRevocationPolicy

rescheduleAfterRevokation

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

Does nothing.

Specified by:

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

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), AbstractSimQueue.removeJobFromQueueUponRevokation(J, double, boolean), SimQueue.AutoRevocationPolicy

removeJobFromQueueUponDeparture

protected final void removeJobFromQueueUponDeparture(J departingJob,
                                                     double time)

Does nothing.

Specified by:

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

Parameters:

departingJob - The job that departs.

time - The departure (current) time.

See Also:

AbstractSimQueue.depart(double, J), AbstractSimQueue.rescheduleAfterDeparture(J, double)

rescheduleAfterDeparture

protected final void rescheduleAfterDeparture(J departedJob,
                                              double time)

Does nothing.

Specified by:

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

Parameters:

departedJob - The departed job.

time - The departure (current) time.

See Also:

AbstractSimQueue.depart(double, J), AbstractSimQueue.removeJobFromQueueUponDeparture(J, double)