Module swim.api

Package swim.api.agent

Interface AgentContext

All Superinterfaces:

DownlinkFactory, LaneFactory, Log, Store, SwimRef

All Known Implementing Classes:

AgentView

public interface AgentContext
extends SwimRef, LaneFactory, Store, Log

Internal context that enables URI-based addressability, contextual Lane and Store creation mechanisms, logging, and scheduling to some Agent.

Method Summary

Modifier and Type	Method	Description
Value	agentId()
FingerTrieSeq<Agent>	agents()
Stage	asyncStage()	The multi-threaded execution Stage on which this AgentContext can run asynchronous operations.
void	closeAgent(String name)
void	closeAgent(Value id)
<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 props().
Value	getProp(Value key)	Returns the value of key in props().
Uri	hostUri()	The hostUri of the Agent managed by this AgentContext.
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.
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)
Lane	openLane(Uri laneUri, Lane lane)	Registers lane with laneUri and returns lane.
Value	props()	A Record that maps every dynamic property in nodeUri(), as defined by AgentRoute.pattern(), to its value.
Schedule	schedule()	The Schedule that this AgentContext is bound to.
Stage	stage()	The single-threaded execution Stage on which this AgentContext runs its application logic.

Methods inherited from interface swim.api.downlink.DownlinkFactory

downlink, downlinkHttp, downlinkList, downlinkMap, downlinkValue, downlinkWs

Methods inherited from interface swim.api.lane.LaneFactory

commandLane, demandLane, demandMapLane, geospatialLane, httpLane, joinMapLane, joinValueLane, listLane, mapLane, spatialLane, supplyLane, valueLane, wsLane

Methods inherited from interface swim.util.Log

debug, error, fail, info, trace, warn

Methods inherited from interface swim.api.store.Store

geospatialData, geospatialData, listData, listData, mapData, mapData, spatialData, spatialData, valueData, valueData

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

Method Detail

hostUri

Uri hostUri()

The hostUri of the Agent managed by this AgentContext.

nodeUri

Uri nodeUri()

The nodeUri of the Agent managed by this AgentContext.

agentId

Value agentId()

props

Value props()

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

getProp

Value getProp(Value key)

Returns the value of key in props().

getProp

Value getProp(String name)

Returns the value of name in props().

schedule

Schedule schedule()

The Schedule that this AgentContext is bound to.

stage

Stage stage()

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

asyncStage

Stage asyncStage()

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

lane

Lane lane()

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

link

Link link()

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

getLane

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.

openLane

Lane openLane(Uri laneUri,
              Lane lane)

Registers lane with laneUri and returns lane.

agents

FingerTrieSeq<Agent> agents()

getAgent

Agent getAgent(Value id)

getAgent

Agent getAgent(String name)

getAgent

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

openAgent

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

openAgent

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

openAgent

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

openAgent

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

openAgent

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

openAgent

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

closeAgent

void closeAgent(Value id)

closeAgent

void closeAgent(String name)