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

Class SINK<J extends SimJob,Q extends SINK>

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.SINK<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 SINK<J extends SimJob,Q extends SINK>
extends AbstractServerlessSimQueue<J,Q>

The SINK queue has unlimited waiting capacity, but does not provide any service and jobs can only leave through revocations.

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.

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

Method Summary

Modifier and Type	Method and Description
SINK<J,Q>	getCopySimQueue() Returns a new SINK 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.
protected void	removeJobFromQueueUponDeparture(J departingJob, double time) Throws IllegalStateException.
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) Does nothing.
protected void	rescheduleAfterDeparture(J departedJob, double time) Throws IllegalStateException.
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 (in order to make implementation final).
String	toStringDefault() Returns "SINK".

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

SINK

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

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

Parameters:

eventList - The event list to use.

Method Detail

getCopySimQueue

public SINK<J,Q> getCopySimQueue()

Returns a new SINK object on the same SimEventList.

Returns:

A new SINK object on the same SimEventList.

See Also:

AbstractSimEntity.getEventList()

toStringDefault

public String toStringDefault()

Returns "SINK".

Specified by:

toStringDefault in interface SimEntity

Overrides:

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

Returns:

"SINK".

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 AbstractSimQueue<J extends SimJob,Q extends SINK>

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

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)

Does nothing.

Specified by:

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

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.arrive(double, J), AbstractSimQueue.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 SINK>

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

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

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

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)

Throws IllegalStateException.

Specified by:

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

Parameters:

departingJob - The job that departs.

time - The departure (current) time.

Throws:

IllegalStateException - Always, as this SimQueue does not allow departures.

See Also:

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

rescheduleAfterDeparture

protected final void rescheduleAfterDeparture(J departedJob,
                                              double time)

Throws IllegalStateException.

Specified by:

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

Parameters:

departedJob - The departed job.

time - The departure (current) time.

Throws:

IllegalStateException - Always, as this SimQueue does not allow departures.

See Also:

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