org.javades.jqueues.r5.util.predictor.state

Interface SimQueueStateHandler

All Known Implementing Classes:

SimQueueCompositeStateHandler, SimQueueOSTStateHandler, SimQueueQoSStateHandler, SimQueueRateLimitStateHandler, SimQueueVisitsCounterStateHandler, SimQueueWithGateStateHandler

public interface SimQueueStateHandler

A handler for an extension to a DefaultSimQueueState.

For a more detailed description of the rationale and architecture of extensions to a DefaultSimQueueState, see the description of WorkloadScheduleHandler for DefaultWorkloadSchedule.

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.

Method Summary

Modifier and Type	Method and Description
String	getHandlerName() Returns the name of the handler.
void	initHandler(DefaultSimQueueState queueState) Initializes the handler, and passes the DefaultSimQueueState object.
void	resetHandler(DefaultSimQueueState queueState) Resets the (state represented by) this handler.

Method Detail

getHandlerName

String getHandlerName()

Returns the name of the handler.

The handler name must be unique within the realm of the DefaultSimQueueState at which this handler registers. For SimQueue state extensions, the convention is to use the interface name appended with "Handler", like, "SimQueueHandler" and "SimQueueWithGateHandler".

Returns:

The name of the handler (must remain fixed during the handler's lifetime).

initHandler

void initHandler(DefaultSimQueueState queueState)

Initializes the handler, and passes the DefaultSimQueueState object.

This method is called only once during registration at the DefaultSimQueueState object.

Parameters:

queueState - The DefaultSimQueueState at which we register, non-null.

See Also:

DefaultSimQueueState.registerHandler(org.javades.jqueues.r5.util.predictor.state.SimQueueStateHandler)

resetHandler

void resetHandler(DefaultSimQueueState queueState)

Resets the (state represented by) this handler.

Parameters:

queueState - The DefaultSimQueueState at which we are registered, non-null.

See Also:

SimQueueState.reset(), DefaultSimQueueState.reset()