io.apigee.trireme.kernel.util

Class PinState

java.lang.Object

io.apigee.trireme.kernel.util.PinState

public class PinState
extends java.lang.Object

This class exists to support the various "pin" and "unpin" behaviors of Node.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PIN_ALLOWED If set, then the user called "unref" which explicitly avoids the pinned state
static int	PIN_REQUESTED If set, then the object has requested a pin from the runtime

Constructor Summary

Constructors

Constructor and Description
PinState()

Method Summary

Modifier and Type	Method and Description
void	clearPin(GenericNodeRuntime runtime) Clear the flag requesting that we pin the script.
void	decrementPinRequest(GenericNodeRuntime runtime)
void	incrementPinRequest(GenericNodeRuntime runtime) This is a wrapper that calls "requestPin" only the first time, and "clearPin" only the last time.
void	ref(GenericNodeRuntime runtime) Clear the state set by unref and pin the script if one had been previously requested.
void	requestPin(GenericNodeRuntime runtime) Set a flag requesting that we pin the script if it was not already pinned or unrefed.
void	unref(GenericNodeRuntime runtime) Set a flag preventing this object from ever pinning the script even if a pin was requested and un-pin if it ever was.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PIN_REQUESTED

public static final int PIN_REQUESTED

If set, then the object has requested a pin from the runtime

See Also:

Constant Field Values

PIN_ALLOWED

public static final int PIN_ALLOWED

If set, then the user called "unref" which explicitly avoids the pinned state

See Also:

Constant Field Values

Constructor Detail

PinState

public PinState()

Method Detail

ref

public void ref(GenericNodeRuntime runtime)

Clear the state set by unref and pin the script if one had been previously requested. This is used to implement the "ref" method on many Node objects.

unref

public void unref(GenericNodeRuntime runtime)

Set a flag preventing this object from ever pinning the script even if a pin was requested and un-pin if it ever was. This is used to implement the "unref" method on many Node objects, which prevent them from keeping the event loop open.

requestPin

public void requestPin(GenericNodeRuntime runtime)

Set a flag requesting that we pin the script if it was not already pinned or unrefed. This is used by internal code that wants to keep the event loop open, but wants the user to be able to override that by calling "unref".

clearPin

public void clearPin(GenericNodeRuntime runtime)

Clear the flag requesting that we pin the script. This is used by internal code to undo a "requestPin".

incrementPinRequest

public void incrementPinRequest(GenericNodeRuntime runtime)

This is a wrapper that calls "requestPin" only the first time, and "clearPin" only the last time. It's for code that might have multiple paths that need to manage pinning.

decrementPinRequest

public void decrementPinRequest(GenericNodeRuntime runtime)