Module swim.runtime

Package swim.runtime.agent

Class AgentNode

java.lang.Object

swim.runtime.AbstractSwimRef

swim.runtime.AbstractTierBinding

swim.runtime.agent.AgentNode

All Implemented Interfaces:

Executor, DownlinkFactory, LaneFactory, SwimRef, Schedule, Stage, Task, TaskFunction, CellBinding, CellContext, NodeBinding, TierBinding, Log

Direct Known Subclasses:

AgentModel

public class AgentNode
extends AbstractTierBinding
implements NodeBinding, CellContext, LaneFactory, Schedule, Stage, Task

Field Summary

Fields

Modifier and Type	Field	Description
protected NodeContext	nodeContext
protected TaskContext	taskContext

Fields inherited from class swim.runtime.AbstractTierBinding

CLOSED_PHASE, CLOSED_STATE, CLOSING_STATE, FAILED_STATE, FAILING_STATE, LOADED_PHASE, LOADED_STATE, LOADING_STATE, OPENED_PHASE, OPENED_STATE, OPENING_STATE, PHASE_MASK, PHASE_SHIFT, RECOVERING_STATE, STARTED_PHASE, STARTED_STATE, STARTING_STATE, STATE_MASK, status, STATUS, STOPPING_STATE, UNLOADING_STATE

Constructor Summary

Constructors

Constructor	Description
AgentNode()

Method Summary

Modifier and Type	Method	Description
LinkBinding	bindDownlink(Downlink downlink)
<T> Call<T>	call(Cont<T> future)	Returns a Call that completes the continuation.
void	closeDownlink(LinkBinding link)
void	closeLane(Uri laneUri)
<V> CommandLane<V>	commandLane()
<A extends Agent> AgentFactory<A>	createAgentFactory(Class<? extends A> agentClass)
AgentFactory<?>	createAgentFactory(AgentDef agentDef)
long	createdTime()
protected LaneContext	createLaneContext(LaneBinding lane, Uri laneUri)
void	debug(Object message)	Logs a debug-level message.
<V> DemandLane<V>	demandLane()
<K,V> DemandMapLane<K,V>	demandMapLane()
void	didClose()
void	didFail(Throwable error)
void	error(Object message)	Logs an error-level message.
void	execute(Runnable command)	Schedules a runnable for concurrent execution.
<K,V> SpatialLane<K,R2Shape,V>	geospatialLane()
LaneBinding	getLane(Uri laneUri)
HostBinding	host()
Uri	hostUri()
<V> HttpLane<V>	httpLane()
void	info(Object message)	Logs an info-level message.
<L,K,V> JoinMapLane<L,K,V>	joinMapLane()
<K,V> JoinValueLane<K,V>	joinValueLane()
HashTrieMap<Uri,LaneBinding>	lanes()
<V> ListLane<V>	listLane()
<K,V> MapLane<K,V>	mapLane()
Uri	meshUri()
NodeContext	nodeContext()
Uri	nodeUri()
NodeBinding	nodeWrapper()
protected static Uri	normalizezLaneUri(Uri laneUri)
void	openAgents(NodeBinding node)
void	openDownlink(LinkBinding link)
LaneBinding	openLane(Uri laneUri)
LaneBinding	openLane(Uri laneUri, Lane lane)
LaneBinding	openLane(Uri laneUri, LaneBinding lane)
void	openLanes(NodeBinding node)
LaneBinding	openLaneView(Uri laneUri, LaneView laneView)
void	openUplink(LinkBinding link)
Value	partKey()
Policy	policy()
void	pushDown(PushRequest pushRequest)
void	pushUp(PushRequest pushRequest)
void	runTask()	Executes this sequential process.
Schedule	schedule()
void	setNodeContext(NodeContext nodeContext)
void	setTaskContext(TaskContext taskContext)	Sets the context used to managed this Task.
TimerRef	setTimer(long millis, TimerFunction timer)	Schedules timer to execute after millis milliseconds have elapsed.
<K,S,V> SpatialLane<K,S,V>	spatialLane(Z2Form<S> shapeForm)
Stage	stage()
StoreBinding	store()
<V> SupplyLane<V>	supplyLane()
TaskRef	task(TaskFunction task)	Returns an uncued TaskRef bound to the task, which can later be used to cue the task.
TaskContext	taskContext()	Returns the context used to managed this Task.
void	taskDidCancel()	Lifecycle callback invoked after this Task is explicitly cancelled.
boolean	taskWillBlock()	Returns true if this Task might block its thread of execution when running; returns false if this Task will never block.
void	taskWillCue()	Lifecycle callback invoked before this Task is scheduled for execution.
TierContext	tierContext()
TimerRef	timer(TimerFunction timer)	Returns an unscheduled TimerRef bound to timer, which can later be used to schedule timer.
void	trace(Object message)	Logs a trace-level message.
<T> T	unwrapNode(Class<T> nodeClass)
<V> ValueLane<V>	valueLane()
void	warn(Object message)	Logs a warn-level message.
protected void	willClose()
protected void	willLoad()
protected void	willOpen()
protected void	willStart()
protected void	willStop()
protected void	willUnload()
<I,O> WsLane<I,O>	wsLane()

Methods inherited from class swim.runtime.AbstractTierBinding

activate, close, didLoad, didOpen, didStart, didStop, didUnload, isClosed, isLoaded, isOpened, isStarted, load, open, start, stop, unload

Methods inherited from class swim.runtime.AbstractSwimRef

command, command, command, command, command, command, command, command, downlink, downlinkHttp, downlinkList, downlinkMap, downlinkValue, downlinkWs, hostRef, hostRef, laneRef, laneRef, laneRef, laneRef, nodeRef, nodeRef, nodeRef, nodeRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface swim.runtime.TierBinding

close, isClosed, isLoaded, isOpened, isStarted, load, open, start, stop, unload

Field Detail

nodeContext

protected NodeContext nodeContext

taskContext

protected TaskContext taskContext

Constructor Detail

AgentNode

public AgentNode()

Method Detail

tierContext

public final TierContext tierContext()

Specified by:

tierContext in interface TierBinding

Specified by:

tierContext in class AbstractTierBinding

host

public final HostBinding host()

Specified by:

host in interface NodeBinding

nodeWrapper

public final NodeBinding nodeWrapper()

Specified by:

nodeWrapper in interface NodeBinding

nodeContext

public final NodeContext nodeContext()

Specified by:

nodeContext in interface NodeBinding

setNodeContext

public void setNodeContext(NodeContext nodeContext)

Specified by:

setNodeContext in interface NodeBinding

unwrapNode

public <T> T unwrapNode(Class<T> nodeClass)

Specified by:

unwrapNode in interface NodeBinding

taskContext

public final TaskContext taskContext()

Description copied from interface: Task

Returns the context used to managed this Task. Returns null if this Task is not bound to a Stage.

Specified by:

taskContext in interface Task

setTaskContext

public void setTaskContext(TaskContext taskContext)

Description copied from interface: Task

Sets the context used to managed this Task. A TaskContext is assigned when binding this Task to a Stage.

Specified by:

setTaskContext in interface Task

createLaneContext

protected LaneContext createLaneContext(LaneBinding lane,
                                        Uri laneUri)

meshUri

public final Uri meshUri()

Specified by:

meshUri in interface CellContext

Specified by:

meshUri in interface NodeBinding

partKey

public final Value partKey()

Specified by:

partKey in interface NodeBinding

hostUri

public final Uri hostUri()

Specified by:

hostUri in interface NodeBinding

nodeUri

public final Uri nodeUri()

Specified by:

nodeUri in interface NodeBinding

createdTime

public long createdTime()

Specified by:

createdTime in interface NodeBinding

openLanes

public void openLanes(NodeBinding node)

Specified by:

openLanes in interface NodeBinding

createAgentFactory

public AgentFactory<?> createAgentFactory(AgentDef agentDef)

Specified by:

createAgentFactory in interface NodeBinding

createAgentFactory

public <A extends Agent> AgentFactory<A> createAgentFactory(Class<? extends A> agentClass)

Specified by:

createAgentFactory in interface NodeBinding

openAgents

public void openAgents(NodeBinding node)

Specified by:

openAgents in interface NodeBinding

normalizezLaneUri

protected static Uri normalizezLaneUri(Uri laneUri)

lanes

public HashTrieMap<Uri,LaneBinding> lanes()

Specified by:

lanes in interface NodeBinding

getLane

public LaneBinding getLane(Uri laneUri)

Specified by:

getLane in interface NodeBinding

openLaneView

public LaneBinding openLaneView(Uri laneUri,
                                LaneView laneView)

openLane

public LaneBinding openLane(Uri laneUri,
                            Lane lane)

openLane

public LaneBinding openLane(Uri laneUri)

Specified by:

openLane in interface NodeBinding

openLane

public LaneBinding openLane(Uri laneUri,
                            LaneBinding lane)

Specified by:

openLane in interface NodeBinding

closeLane

public void closeLane(Uri laneUri)

commandLane

public <V> CommandLane<V> commandLane()

Specified by:

commandLane in interface LaneFactory

demandLane

public <V> DemandLane<V> demandLane()

Specified by:

demandLane in interface LaneFactory

demandMapLane

public <K,V> DemandMapLane<K,V> demandMapLane()

Specified by:

demandMapLane in interface LaneFactory

httpLane

public <V> HttpLane<V> httpLane()

Specified by:

httpLane in interface LaneFactory

joinMapLane

public <L,K,V> JoinMapLane<L,K,V> joinMapLane()

Specified by:

joinMapLane in interface LaneFactory

joinValueLane

public <K,V> JoinValueLane<K,V> joinValueLane()

Specified by:

joinValueLane in interface LaneFactory

listLane

public <V> ListLane<V> listLane()

Specified by:

listLane in interface LaneFactory

mapLane

public <K,V> MapLane<K,V> mapLane()

Specified by:

mapLane in interface LaneFactory

spatialLane

public <K,S,V> SpatialLane<K,S,V> spatialLane(Z2Form<S> shapeForm)

Specified by:

spatialLane in interface LaneFactory

geospatialLane

public <K,V> SpatialLane<K,R2Shape,V> geospatialLane()

Specified by:

geospatialLane in interface LaneFactory

supplyLane

public <V> SupplyLane<V> supplyLane()

Specified by:

supplyLane in interface LaneFactory

valueLane

public <V> ValueLane<V> valueLane()

Specified by:

valueLane in interface LaneFactory

wsLane

public <I,O> WsLane<I,O> wsLane()

Specified by:

wsLane in interface LaneFactory

openUplink

public void openUplink(LinkBinding link)

Specified by:

openUplink in interface CellBinding

bindDownlink

public LinkBinding bindDownlink(Downlink downlink)

Specified by:

bindDownlink in interface CellContext

openDownlink

public void openDownlink(LinkBinding link)

Specified by:

openDownlink in interface CellContext

closeDownlink

public void closeDownlink(LinkBinding link)

Specified by:

closeDownlink in interface CellContext

pushUp

public void pushUp(PushRequest pushRequest)

Specified by:

pushUp in interface CellBinding

pushDown

public void pushDown(PushRequest pushRequest)

Specified by:

pushDown in interface CellContext

trace

public void trace(Object message)

Description copied from interface: Log

Logs a trace-level message.

Specified by:

trace in interface Log

debug

public void debug(Object message)

Description copied from interface: Log

Logs a debug-level message.

Specified by:

debug in interface Log

info

public void info(Object message)

Description copied from interface: Log

Logs an info-level message.

Specified by:

info in interface Log

warn

public void warn(Object message)

Description copied from interface: Log

Logs a warn-level message.

Specified by:

warn in interface Log

error

public void error(Object message)

Description copied from interface: Log

Logs an error-level message.

Specified by:

error in interface Log

willOpen

protected void willOpen()

Overrides:

willOpen in class AbstractTierBinding

willLoad

protected void willLoad()

Overrides:

willLoad in class AbstractTierBinding

willStart

protected void willStart()

Overrides:

willStart in class AbstractTierBinding

willStop

protected void willStop()

Overrides:

willStop in class AbstractTierBinding

willUnload

protected void willUnload()

Overrides:

willUnload in class AbstractTierBinding

willClose

protected void willClose()

Overrides:

willClose in class AbstractTierBinding

didClose

public void didClose()

Specified by:

didClose in interface TierBinding

Overrides:

didClose in class AbstractTierBinding

didFail

public void didFail(Throwable error)

Specified by:

didFail in interface TierBinding

Overrides:

didFail in class AbstractTierBinding

policy

public Policy policy()

Specified by:

policy in interface CellContext

schedule

public Schedule schedule()

Specified by:

schedule in interface CellContext

stage

public Stage stage()

Specified by:

stage in interface CellContext

store

public StoreBinding store()

Specified by:

store in interface CellContext

timer

public TimerRef timer(TimerFunction timer)

Description copied from interface: Schedule

Returns an unscheduled TimerRef bound to timer, which can later be used to schedule timer.

Specified by:

timer in interface Schedule

setTimer

public TimerRef setTimer(long millis,
                         TimerFunction timer)

Description copied from interface: Schedule

Schedules timer to execute after millis milliseconds have elapsed. Returns a TimerRef that can be used to check the status of, reschedule, and cancel timer.

Specified by:

setTimer in interface Schedule

task

public TaskRef task(TaskFunction task)

Description copied from interface: Stage

Returns an uncued TaskRef bound to the task, which can later be used to cue the task.

Specified by:

task in interface Stage

call

public <T> Call<T> call(Cont<T> future)

Description copied from interface: Stage

Returns a Call that completes the continuation.

Specified by:

call in interface Stage

execute

public void execute(Runnable command)

Description copied from interface: Stage

Schedules a runnable for concurrent execution.

Specified by:

execute in interface Executor

Specified by:

execute in interface Stage

taskWillBlock

public boolean taskWillBlock()

Description copied from interface: Task

Returns true if this Task might block its thread of execution when running; returns false if this Task will never block. Used by the execution Stage to prevent thread starvation when concurrently running many blocking tasks.

Specified by:

taskWillBlock in interface Task

runTask

public void runTask()

Description copied from interface: Task

Executes this sequential process. Only one thread at a time will execute runTask for this Task.

Specified by:

runTask in interface Task

Specified by:

runTask in interface TaskFunction

taskWillCue

public void taskWillCue()

Description copied from interface: Task

Lifecycle callback invoked before this Task is scheduled for execution.

Specified by:

taskWillCue in interface Task

taskDidCancel

public void taskDidCancel()

Description copied from interface: Task

Lifecycle callback invoked after this Task is explicitly cancelled.

Specified by:

taskDidCancel in interface Task