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

Class DLIMIT<J extends SimJob,Q extends DLIMIT>

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

Direct Known Subclasses:

LeakyBucket

public class DLIMIT<J extends SimJob,Q extends DLIMIT>
extends AbstractServerlessSimQueue<J,Q>

In the DLIMIT queue jobs depart without service in arrival order, but not at a higher rate than a given limit, at the expense of waiting.

This SimQueue is server-less.

The operation of this SimQueue is controlled by the rateLimit property, see getRateLimit(). It must be non-negative and is set upon construction; and cannot be changed afterwards. If set to zero, this queue behaves as SINK. If so to positive infinite, this queue behaves as ZERO. The DLIMIT queueing discipline is equivalent to LeakyBucket with 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.

See Also:

ZERO, SINK, DELAY, LeakyBucket

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DLIMIT.RateLimitExpirationEvent<Q extends DLIMIT> The default SimEvent used internally for scheduling rate-limit expirations.

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
DLIMIT(org.javades.jsimulation.r5.SimEventList eventList, double rateLimit) Creates a DLIMIT queue with infinite buffer size given an event list and (departure) rate limit.

Method Summary

Modifier and Type	Method and Description
DLIMIT<J,Q>	getCopySimQueue() Returns a new DLIMIT object on the same SimEventList with the same (departure) rate limit.
Object	getQoS() Calls super method (in order to make implementation final).
Class	getQoSClass() Calls super method (in order to make implementation final).
double	getRateLimit() Returns the (immutable) rate limit for departures (non-negative).
protected void	insertJobInQueueUponArrival(J job, double time) Does nothing.
protected boolean	isRateLimited() Returns whether this queue is currently (departure) rate limited.
protected void	rateLimitExpiration(DLIMIT.RateLimitExpirationEvent<Q> event) Notification of rate-limit expiration from an internally-scheduled DLIMIT.RateLimitExpirationEvent.
protected void	removeJobFromQueueUponDeparture(J departingJob, double time) Does nothing.
protected void	removeJobFromQueueUponDrop(J job, double time) Does nothing.
protected void	removeJobFromQueueUponRevokation(J job, double time, boolean auto) Does nothing.
protected void	rescheduleAfterArrival(J job, double time) Makes the job depart if the queue is not rate-limited; otherwise drop it if the waiting queue is "overflown".
protected void	rescheduleAfterDeparture(J departedJob, double time) Schedules a new DLIMIT.RateLimitExpirationEvent if the departure-rate limit is finite and non-zero.
protected void	rescheduleAfterDrop(J job, double time) Does nothing.
protected void	rescheduleAfterRevokation(J job, double time, boolean auto) Does nothing.
protected void	resetEntitySubClass() Calls super method and properly sets the rate limitation.
protected DLIMIT.RateLimitExpirationEvent<Q>	scheduleRateLimitExpirationEvent(double expirationTime) Schedules a suitable SimEvent for a rate-limit expiration on the event list.
String	toStringDefault() Returns "DLIMIT[rateLimit]".

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

DLIMIT

public DLIMIT(org.javades.jsimulation.r5.SimEventList eventList,
              double rateLimit)

Creates a DLIMIT queue with infinite buffer size given an event list and (departure) rate limit.

Parameters:

eventList - The event list to use.

rateLimit - The (departure) rate limit, non-negative.

Throws:

IllegalArgumentException - If the rate limit is strictly negative.

Method Detail

getCopySimQueue

public DLIMIT<J,Q> getCopySimQueue()

Returns a new DLIMIT object on the same SimEventList with the same (departure) rate limit.

Returns:

A new DLIMIT object on the same SimEventList with the same (departure) rate limit.

See Also:

AbstractSimEntity.getEventList(), getRateLimit()

toStringDefault

public String toStringDefault()

Returns "DLIMIT[rateLimit]".

Specified by:

toStringDefault in interface SimEntity

Overrides:

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

Returns:

"DLIMIT[rateLimit]".

See Also:

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

getRateLimit

public final double getRateLimit()

Returns the (immutable) rate limit for departures (non-negative).

The (departure) rate limit is set upon construction, and cannot be changed afterwards.

Returns:

The (immutable) rate limit for departures (non-negative).

isRateLimited

protected final boolean isRateLimited()

Returns whether this queue is currently (departure) rate limited.

Returns:

{code true} if this queue is currently (departure) rate limited.

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 and properly sets the rate limitation.

Since we always schedule DLIMIT.RateLimitExpirationEvent through AbstractSimQueue.eventsScheduled, our super-class will cancel them automatically (if needed).

Overrides:

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

See Also:

isRateLimited

insertJobInQueueUponArrival

protected final void insertJobInQueueUponArrival(J job,
                                                 double time)

Does nothing.

Specified by:

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

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 if the queue is not rate-limited; otherwise drop it if the waiting queue is "overflown".

Specified by:

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

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:

isRateLimited, AbstractSimQueue.depart(double, J), insertJobInQueueUponArrival(J, double)

removeJobFromQueueUponDrop

protected final void removeJobFromQueueUponDrop(J job,
                                                double time)

Does nothing.

Specified by:

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

Parameters:

job - The job that is to be dropped.

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

See Also:

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

rescheduleAfterDrop

protected final void rescheduleAfterDrop(J job,
                                         double time)

Does nothing.

Specified by:

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

Parameters:

job - The jobs that was dropped.

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

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

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

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

rateLimitExpiration

protected final void rateLimitExpiration(DLIMIT.RateLimitExpirationEvent<Q> event)

Notification of rate-limit expiration from an internally-scheduled DLIMIT.RateLimitExpirationEvent.

Invokes AbstractSimEntity.update(double) and AbstractSimEntity.clearAndUnlockPendingNotificationsIfLocked(), insisting to be a top-level event (at the expense of an IllegalStateException).

If there are job in the waiting area, it makes depart the first one. Otherwise, it invokes AbstractSimQueue.triggerPotentialNewStartArmed(double).

Finally, it notifies listeners through AbstractSimEntity.fireAndLockPendingNotifications().

Parameters:

event - The event that invoked us through its SimEventAction, non-null.

See Also:

DLIMIT.RateLimitExpirationEvent, AbstractSimQueue.eventsScheduled, isRateLimited, AbstractSimQueue.hasJobsInWaitingArea(), AbstractSimQueue.depart(double, J), AbstractSimQueue.triggerPotentialNewStartArmed(double), AbstractSimEntity.clearAndUnlockPendingNotificationsIfLocked(), AbstractSimEntity.fireAndLockPendingNotifications()

scheduleRateLimitExpirationEvent

protected final DLIMIT.RateLimitExpirationEvent<Q> scheduleRateLimitExpirationEvent(double expirationTime)

Schedules a suitable SimEvent for a rate-limit expiration on the event list.

The implementation creates a new DLIMIT.RateLimitExpirationEvent, adds it to AbstractSimQueue.eventsScheduled and schedules the new event on the event list. Effectively, this ensures that unless the event is canceled, the method rateLimitExpiration(org.javades.jqueues.r5.entity.jq.queue.serverless.DLIMIT.RateLimitExpirationEvent<Q>) is invoked upon reaching the event.

Parameters:

expirationTime - The scheduled expiration time.

Returns:

The event created and scheduled on the event list.

See Also:

AbstractSimEntity.getEventList(), AbstractSimEntity.getLastUpdateTime(), AbstractSimQueue.eventsScheduled

removeJobFromQueueUponDeparture

protected final void removeJobFromQueueUponDeparture(J departingJob,
                                                     double time)

Does nothing.

Specified by:

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

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)

Schedules a new DLIMIT.RateLimitExpirationEvent if the departure-rate limit is finite and non-zero.

If the rate limit is zero or negative, this method throws an exception, as departures are not supposed to happen.

Specified by:

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

Parameters:

departedJob - The departed job.

time - The departure (current) time.

Throws:

IllegalStateException - If the rate limit is not strictly positive, or if this queue is currently under rate-limitation, as determined through isRateLimited, in both cases of which departures should not occur.

See Also:

isRateLimited, getRateLimit(), scheduleRateLimitExpirationEvent(double)