Module swim.runtime

Package swim.runtime.agent

Class AgentView

java.lang.Object

swim.runtime.AbstractSwimRef

swim.runtime.AbstractTierBinding

swim.runtime.agent.AgentView

All Implemented Interfaces:

AgentContext, DownlinkFactory, LaneFactory, SwimRef, Store, CellContext, TierBinding, TierContext, Log

public class AgentView
extends AbstractTierBinding
implements TierContext, AgentContext

Field Summary

Fields

Modifier and Type	Field	Description
protected Agent	agent
protected Value	id
protected AgentModel	node
protected Value	props

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
AgentView(AgentModel node, Value id, Value props)

Method Summary

Modifier and Type	Method	Description
Agent	agent()
Value	agentId()
FingerTrieSeq<Agent>	agents()
Stage	asyncStage()	The multi-threaded execution Stage on which this AgentContext can run asynchronous operations.
LinkBinding	bindDownlink(Downlink downlink)
<T> T	bottomNode(Class<T> nodeClass)
NodeAddress	cellAddress()
void	closeAgent(String name)
void	closeAgent(Value id)
void	closeDownlink(LinkBinding link)
<V> CommandLane<V>	commandLane()
<A extends Agent> AgentFactory<A>	createAgentFactory(Class<? extends A> agentClass)
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	didLoad()
void	didOpen()
void	didStart()
void	didStop()
void	didUnload()
String	edgeName()
void	error(Object message)	Logs an error-level message.
void	fail(Object message)	Logs an fail-level message.
SpatialData<Value,R2Shape,Value>	geospatialData(String name)
SpatialData<Value,R2Shape,Value>	geospatialData(Value name)
<K,V> SpatialLane<K,R2Shape,V>	geospatialLane()
<A extends Agent> A	getAgent(Class<? extends A> agentClass)
Agent	getAgent(String name)
Agent	getAgent(Value id)
Lane	getLane(Uri laneUri)	Returns the Lane belonging to the Agent managed by this AgentContext that is addressable by laneUri, or null if no such Lane exists.
Value	getProp(String name)	Returns the value of name in AgentContext.props().
Value	getProp(Value key)	Returns the value of key in AgentContext.props().
Uri	hostUri()	The hostUri of the Agent managed by this AgentContext.
<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()
Lane	lane()	Returns the currently executing lane, or null if not currently executing a lane or link callback.
Link	link()	Returns the currently executing link, or null if not currently executing a link callback.
ListData<Value>	listData(String name)
ListData<Value>	listData(Value name)
<V> ListLane<V>	listLane()
MapData<Value,Value>	mapData(String name)
MapData<Value,Value>	mapData(Value name)
<K,V> MapLane<K,V>	mapLane()
Uri	meshUri()
Uri	nodeUri()	The nodeUri of the Agent managed by this AgentContext.
<A extends Agent> A	openAgent(String name, Class<? extends A> agentClass)
<A extends Agent> A	openAgent(String name, AgentFactory<A> agentFactory)
<A extends Agent> A	openAgent(Value id, Class<? extends A> agentClass)
<A extends Agent> A	openAgent(Value id, AgentFactory<A> agentFactory)
<A extends Agent> A	openAgent(Value id, Value props, Class<? extends A> agentClass)
<A extends Agent> A	openAgent(Value id, Value props, AgentFactory<A> agentFactory)
void	openDownlink(LinkBinding link)
Lane	openLane(Uri laneUri, Lane lane)	Registers lane with laneUri and returns lane.
void	openMetaDownlink(LinkBinding downlink, NodeBinding metaDownlink)
Policy	policy()
Value	props()	A Record that maps every dynamic property in AgentContext.nodeUri(), as defined by AgentRoute.pattern(), to its value.
void	pushDown(Push<?> push)
void	reportDown(Metric metric)
Schedule	schedule()	The Schedule that this AgentContext is bound to.
<S> SpatialData<Value,S,Value>	spatialData(String name, Z2Form<S> shapeForm)
<S> SpatialData<Value,S,Value>	spatialData(Value name, Z2Form<S> shapeForm)
<K,S,V> SpatialLane<K,S,V>	spatialLane(Z2Form<S> shapeForm)
Stage	stage()	The single-threaded execution Stage on which this AgentContext runs its application logic.
StoreBinding	store()
<V> SupplyLane<V>	supplyLane()
TierContext	tierContext()
void	trace(Object message)	Logs a trace-level message.
<T> T	unwrapNode(Class<T> nodeClass)
ValueData<Value>	valueData(String name)
ValueData<Value>	valueData(Value name)
<V> ValueLane<V>	valueLane()
void	warn(Object message)	Logs a warn-level message.
void	willClose()
void	willLoad()
void	willOpen()
void	willStart()
void	willStop()
void	willUnload()
<I,O> WsLane<I,O>	wsLane()

Methods inherited from class swim.runtime.AbstractTierBinding

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

Methods inherited from class swim.runtime.AbstractSwimRef

command, command, command, command, command, command, command, command, 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.api.downlink.DownlinkFactory

downlink, downlinkHttp, downlinkList, downlinkMap, downlinkValue, downlinkWs

Methods inherited from interface swim.api.ref.SwimRef

close, command, command, command, command, command, command, command, command, command, command, command, command, command, command, command, command, hostRef, hostRef, laneRef, laneRef, laneRef, laneRef, nodeRef, nodeRef, nodeRef, nodeRef

Methods inherited from interface swim.runtime.TierContext

close

Field Detail

node

protected final AgentModel node

id

protected final Value id

props

protected final Value props

agent

protected Agent agent

Constructor Detail

AgentView

public AgentView(AgentModel node,
                 Value id,
                 Value props)

Method Detail

agent

public final Agent agent()

tierContext

public TierContext tierContext()

Specified by:

tierContext in interface TierBinding

Specified by:

tierContext in class AbstractTierBinding

unwrapNode

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

bottomNode

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

cellAddress

public NodeAddress cellAddress()

Specified by:

cellAddress in interface CellContext

edgeName

public final String edgeName()

Specified by:

edgeName in interface CellContext

meshUri

public final Uri meshUri()

Specified by:

meshUri in interface CellContext

hostUri

public final Uri hostUri()

Description copied from interface: AgentContext

The hostUri of the Agent managed by this AgentContext.

Specified by:

hostUri in interface AgentContext

nodeUri

public final Uri nodeUri()

Description copied from interface: AgentContext

The nodeUri of the Agent managed by this AgentContext.

Specified by:

nodeUri in interface AgentContext

agentId

public final Value agentId()

Specified by:

agentId in interface AgentContext

props

public final Value props()

Description copied from interface: AgentContext

A Record that maps every dynamic property in AgentContext.nodeUri(), as defined by AgentRoute.pattern(), to its value. An empty result indicates that nodeUri contains no dynamic components.

Specified by:

props in interface AgentContext

getProp

public Value getProp(Value key)

Description copied from interface: AgentContext

Returns the value of key in AgentContext.props().

Specified by:

getProp in interface AgentContext

getProp

public Value getProp(String name)

Description copied from interface: AgentContext

Returns the value of name in AgentContext.props().

Specified by:

getProp in interface AgentContext

policy

public Policy policy()

Specified by:

policy in interface CellContext

schedule

public Schedule schedule()

Description copied from interface: AgentContext

The Schedule that this AgentContext is bound to.

Specified by:

schedule in interface AgentContext

Specified by:

schedule in interface CellContext

stage

public Stage stage()

Description copied from interface: AgentContext

The single-threaded execution Stage on which this AgentContext runs its application logic.

Specified by:

stage in interface AgentContext

Specified by:

stage in interface CellContext

asyncStage

public Stage asyncStage()

Description copied from interface: AgentContext

The multi-threaded execution Stage on which this AgentContext can run asynchronous operations.

Specified by:

asyncStage in interface AgentContext

store

public StoreBinding store()

Specified by:

store in interface CellContext

lane

public Lane lane()

Description copied from interface: AgentContext

Returns the currently executing lane, or null if not currently executing a lane or link callback.

Specified by:

lane in interface AgentContext

link

public Link link()

Description copied from interface: AgentContext

Returns the currently executing link, or null if not currently executing a link callback.

Specified by:

link in interface AgentContext

getLane

public Lane getLane(Uri laneUri)

Description copied from interface: AgentContext

Returns the Lane belonging to the Agent managed by this AgentContext that is addressable by laneUri, or null if no such Lane exists.

Specified by:

getLane in interface AgentContext

openLane

public Lane openLane(Uri laneUri,
                     Lane lane)

Description copied from interface: AgentContext

Registers lane with laneUri and returns lane.

Specified by:

openLane in interface AgentContext

agents

public FingerTrieSeq<Agent> agents()

Specified by:

agents in interface AgentContext

getAgent

public Agent getAgent(Value id)

Specified by:

getAgent in interface AgentContext

getAgent

public Agent getAgent(String name)

Specified by:

getAgent in interface AgentContext

getAgent

public <A extends Agent> A getAgent(Class<? extends A> agentClass)

Specified by:

getAgent in interface AgentContext

createAgentFactory

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

openAgent

public <A extends Agent> A openAgent(Value id,
                                     Value props,
                                     AgentFactory<A> agentFactory)

Specified by:

openAgent in interface AgentContext

openAgent

public <A extends Agent> A openAgent(Value id,
                                     AgentFactory<A> agentFactory)

Specified by:

openAgent in interface AgentContext

openAgent

public <A extends Agent> A openAgent(String name,
                                     AgentFactory<A> agentFactory)

Specified by:

openAgent in interface AgentContext

openAgent

public <A extends Agent> A openAgent(Value id,
                                     Value props,
                                     Class<? extends A> agentClass)

Specified by:

openAgent in interface AgentContext

openAgent

public <A extends Agent> A openAgent(Value id,
                                     Class<? extends A> agentClass)

Specified by:

openAgent in interface AgentContext

openAgent

public <A extends Agent> A openAgent(String name,
                                     Class<? extends A> agentClass)

Specified by:

openAgent in interface AgentContext

closeAgent

public void closeAgent(Value id)

Specified by:

closeAgent in interface AgentContext

closeAgent

public void closeAgent(String name)

Specified by:

closeAgent in interface AgentContext

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

listData

public ListData<Value> listData(Value name)

Specified by:

listData in interface Store

listData

public ListData<Value> listData(String name)

Specified by:

listData in interface Store

mapData

public MapData<Value,Value> mapData(Value name)

Specified by:

mapData in interface Store

mapData

public MapData<Value,Value> mapData(String name)

Specified by:

mapData in interface Store

spatialData

public <S> SpatialData<Value,S,Value> spatialData(Value name,
                                                              Z2Form<S> shapeForm)

Specified by:

spatialData in interface Store

spatialData

public <S> SpatialData<Value,S,Value> spatialData(String name,
                                                              Z2Form<S> shapeForm)

Specified by:

spatialData in interface Store

geospatialData

public SpatialData<Value,R2Shape,Value> geospatialData(Value name)

Specified by:

geospatialData in interface Store

geospatialData

public SpatialData<Value,R2Shape,Value> geospatialData(String name)

Specified by:

geospatialData in interface Store

valueData

public ValueData<Value> valueData(Value name)

Specified by:

valueData in interface Store

valueData

public ValueData<Value> valueData(String name)

Specified by:

valueData in interface Store

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

pushDown

public void pushDown(Push<?> push)

Specified by:

pushDown in interface CellContext

reportDown

public void reportDown(Metric metric)

Specified by:

reportDown in interface CellContext

openMetaDownlink

public void openMetaDownlink(LinkBinding downlink,
                             NodeBinding metaDownlink)

Specified by:

openMetaDownlink 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

fail

public void fail(Object message)

Description copied from interface: Log

Logs an fail-level message.

Specified by:

fail in interface Log

willOpen

public void willOpen()

Specified by:

willOpen in interface TierContext

Overrides:

willOpen in class AbstractTierBinding

didOpen

public void didOpen()

Specified by:

didOpen in interface TierContext

Overrides:

didOpen in class AbstractTierBinding

willLoad

public void willLoad()

Specified by:

willLoad in interface TierContext

Overrides:

willLoad in class AbstractTierBinding

didLoad

public void didLoad()

Specified by:

didLoad in interface TierContext

Overrides:

didLoad in class AbstractTierBinding

willStart

public void willStart()

Specified by:

willStart in interface TierContext

Overrides:

willStart in class AbstractTierBinding

didStart

public void didStart()

Specified by:

didStart in interface TierContext

Overrides:

didStart in class AbstractTierBinding

willStop

public void willStop()

Specified by:

willStop in interface TierContext

Overrides:

willStop in class AbstractTierBinding

didStop

public void didStop()

Specified by:

didStop in interface TierContext

Overrides:

didStop in class AbstractTierBinding

willUnload

public void willUnload()

Specified by:

willUnload in interface TierContext

Overrides:

willUnload in class AbstractTierBinding

didUnload

public void didUnload()

Specified by:

didUnload in interface TierContext

Overrides:

didUnload in class AbstractTierBinding

willClose

public void willClose()

Specified by:

willClose in interface TierContext

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