Module swim.system

Package swim.system.downlink

Class ValueDownlinkView<V>

java.lang.Object

swim.system.DownlinkView

swim.system.warp.WarpDownlinkView

swim.system.downlink.ValueDownlinkView<V>

All Implemented Interfaces:

Downlink, ValueDownlink<V>, Link, WarpDownlink, WarpLink, Observable<Object>, ObservableValue<V>, Inlet<V>, Outlet<V>, Log

Direct Known Subclasses:

JoinValueLaneDownlink

public class ValueDownlinkView<V>
extends WarpDownlinkView
implements ValueDownlink<V>

Field Summary

Fields

Modifier and Type	Field	Description
protected Outlet<? extends V>	input
protected ValueDownlinkModel	model
protected Inlet<? super V>[]	outputs
protected static int	STATEFUL
protected Form<V>	valueForm
protected int	version

Fields inherited from class swim.system.warp.WarpDownlinkView

body, flags, hostUri, KEEP_LINKED, KEEP_SYNCED, laneUri, meshUri, nodeUri, prio, rate

Fields inherited from class swim.system.DownlinkView

cellContext, observers, stage

Constructor Summary

Constructors

Constructor	Description
ValueDownlinkView(CellContext cellContext, Stage stage, Uri meshUri, Uri hostUri, Uri nodeUri, Uri laneUri, float prio, float rate, Value body, int flags, Form<V> valueForm, Object observers)
ValueDownlinkView(CellContext cellContext, Stage stage, Uri meshUri, Uri hostUri, Uri nodeUri, Uri laneUri, float prio, float rate, Value body, Form<V> valueForm)

Method Summary

Modifier and Type	Method	Description
void	bindInput(Outlet<? extends V> input)	Connects this Inlet to an Outlet from which it will acquire its state.
void	bindOutput(Inlet<? super V> output)	Adds an output to the set of Inlets that depend on the state of this Outlet.
ValueDownlinkView<V>	body(Value body)
void	close()
ValueDownlinkModel	createDownlinkModel()
void	decohere()
void	decohereInput()	Marks this Outlet—and all outputs that depend on the state of this Outlet—as having decoherent state.
void	decohereOutput()	Marks this Inlet—and the Streamlet to which this Inlet is attached—as having decoherent state.
ValueDownlinkView<V>	didClose(DidClose didClose)
ValueDownlinkView<V>	didConnect(DidConnect didConnect)
protected void	didDecohere()
ValueDownlinkView<V>	didDisconnect(DidDisconnect didDisconnect)
ValueDownlinkView<V>	didFail(DidFail didFail)
ValueDownlinkView<V>	didLink(DidLink didLink)
ValueDownlinkView<V>	didReceive(DidReceive didReceive)
protected void	didRecohere(int version)
ValueDownlinkView<V>	didSet(DidSet<V> didSet)
ValueDownlinkView<V>	didSync(DidSync didSync)
ValueDownlinkView<V>	didUnlink(DidUnlink didUnlink)
void	disconnectInputs()	Disconnects all Inlets dominated by this Inlet in the dataflow dependency graph.
void	disconnectOutputs()	Disconnects all Outlets dominated by this Inlet in the dataflow graph.
boolean	dispatchDidSet(V newValue, V oldValue, boolean preemptive)
Map.Entry<Boolean,V>	dispatchWillSet(V newValue, boolean preemptive)
void	downlinkDidSet(V newValue, V oldValue)
void	downlinkDidSetValue(Value newValue, Value oldValue)
ValueDownlinkModel	downlinkModel()
V	downlinkWillSet(V newValue)
Value	downlinkWillSetValue(Value newValue)
V	get()	Returns the current state of this Outlet.
ValueDownlinkView<V>	hostUri(String hostUri)
ValueDownlinkView<V>	hostUri(Uri hostUri)
Outlet<? extends V>	input()	Returns the Outlet from which this Inlet acquires its state; returns null if this Inlet is disconnected.
boolean	isStateful()
ValueDownlinkView<V>	isStateful(boolean isStateful)
ValueDownlinkView<V>	keepLinked(boolean keepLinked)
ValueDownlinkView<V>	keepSynced(boolean keepSynced)
ValueDownlinkView<V>	laneUri(String laneUri)
ValueDownlinkView<V>	laneUri(Uri laneUri)
ValueDownlinkView<V>	nodeUri(String nodeUri)
ValueDownlinkView<V>	nodeUri(Uri nodeUri)
ValueDownlinkView<V>	observe(Object observer)
protected void	onDecohere()
protected void	onRecohere(int version)
ValueDownlinkView<V>	open()
Iterator<Inlet<? super V>>	outputIterator()	Returns an Iterator over the set of Inlets that depend on the state of this Outlet.
ValueDownlinkView<V>	prio(float prio)
ValueDownlinkView<V>	rate(float rate)
void	recohere(int version)
void	recohereInput(int version)	Updates the state of this Outlet to make it consistent with the target version.
void	recohereOutput(int version)	Updates the state of this Inlet to make it consistent with the target version.
V	set(V newValue)
protected Object	typesafeObservers(Object observers)
void	unbindInput()	Disconnects this Inlet from its input Outlet, if connected.
void	unbindOutput(Inlet<? super V> output)	Removes an output from the set of Inlets that depend on the state of this Outlet.
void	unbindOutputs()	Disconnects all outputs from this Outlet by invoking Inlet.unbindInput() on each Inelt that depends on the state of this Outlet.
ValueDownlinkView<V>	unobserve(Object observer)
<V2> ValueDownlinkView<V2>	valueClass(Class<V2> valueClass)
Form<V>	valueForm()
<V2> ValueDownlinkView<V2>	valueForm(Form<V2> valueForm)
ValueDownlinkView<V>	willCommand(WillCommand willCommand)
protected void	willDecohere()
ValueDownlinkView<V>	willLink(WillLink willLink)
ValueDownlinkView<V>	willReceive(WillReceive willReceive)
protected void	willRecohere(int version)
ValueDownlinkView<V>	willSet(WillSet<V> willSet)
ValueDownlinkView<V>	willSync(WillSync willSync)
ValueDownlinkView<V>	willUnlink(WillUnlink willUnlink)

Methods inherited from class swim.system.warp.WarpDownlinkView

body, command, command, command, command, dispatchDidLink, dispatchDidReceive, dispatchDidSync, dispatchDidUnlink, dispatchWillCommand, dispatchWillLink, dispatchWillReceive, dispatchWillSync, dispatchWillUnlink, downlinkDidLink, downlinkDidReceive, downlinkDidSync, downlinkDidUnlink, downlinkWillCommand, downlinkWillLink, downlinkWillReceive, downlinkWillSync, downlinkWillUnlink, hostUri, keepLinked, keepSynced, laneUri, meshUri, nodeUri, prio, rate

Methods inherited from class swim.system.DownlinkView

cellContext, cipherSuite, debug, dispatchDidClose, dispatchDidConnect, dispatchDidDisconnect, dispatchDidFail, downlinkDidClose, downlinkDidConnect, downlinkDidDisconnect, downlinkDidFail, error, fail, info, isConnected, isRemote, isSecure, localAddress, localCertificates, localIdentity, localPrincipal, remoteAddress, remoteCertificates, remoteIdentity, remotePrincipal, securityProtocol, stage, trace, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface swim.api.Link

cipherSuite, hostUri, isConnected, isRemote, isSecure, laneUri, localAddress, localCertificates, localIdentity, localPrincipal, nodeUri, remoteAddress, remoteCertificates, remoteIdentity, remotePrincipal, securityProtocol

Methods inherited from interface swim.util.Log

debug, error, fail, info, trace, warn

Methods inherited from interface swim.streamlet.Outlet

map, memoize, watch

Methods inherited from interface swim.api.warp.WarpDownlink

body, command, command, command, command, keepLinked, keepSynced, prio, rate

Field Detail

valueForm

protected final Form<V> valueForm

model

protected ValueDownlinkModel model

input

protected Outlet<? extends V> input

outputs

protected Inlet<? super V>[] outputs

version

protected int version

STATEFUL

protected static final int STATEFUL

See Also:

Constant Field Values

Constructor Detail

ValueDownlinkView

public ValueDownlinkView(CellContext cellContext,
                         Stage stage,
                         Uri meshUri,
                         Uri hostUri,
                         Uri nodeUri,
                         Uri laneUri,
                         float prio,
                         float rate,
                         Value body,
                         int flags,
                         Form<V> valueForm,
                         Object observers)

ValueDownlinkView

public ValueDownlinkView(CellContext cellContext,
                         Stage stage,
                         Uri meshUri,
                         Uri hostUri,
                         Uri nodeUri,
                         Uri laneUri,
                         float prio,
                         float rate,
                         Value body,
                         Form<V> valueForm)

Method Detail

downlinkModel

public ValueDownlinkModel downlinkModel()

Specified by:

downlinkModel in class WarpDownlinkView

hostUri

public ValueDownlinkView<V> hostUri(Uri hostUri)

Specified by:

hostUri in interface ValueDownlink<V>

Specified by:

hostUri in interface WarpDownlink

Specified by:

hostUri in class WarpDownlinkView

hostUri

public ValueDownlinkView<V> hostUri(String hostUri)

Specified by:

hostUri in interface ValueDownlink<V>

Specified by:

hostUri in interface WarpDownlink

Specified by:

hostUri in class WarpDownlinkView

nodeUri

public ValueDownlinkView<V> nodeUri(Uri nodeUri)

Specified by:

nodeUri in interface ValueDownlink<V>

Specified by:

nodeUri in interface WarpDownlink

Specified by:

nodeUri in class WarpDownlinkView

nodeUri

public ValueDownlinkView<V> nodeUri(String nodeUri)

Specified by:

nodeUri in interface ValueDownlink<V>

Specified by:

nodeUri in interface WarpDownlink

Specified by:

nodeUri in class WarpDownlinkView

laneUri

public ValueDownlinkView<V> laneUri(Uri laneUri)

Specified by:

laneUri in interface ValueDownlink<V>

Specified by:

laneUri in interface WarpDownlink

Specified by:

laneUri in class WarpDownlinkView

laneUri

public ValueDownlinkView<V> laneUri(String laneUri)

Specified by:

laneUri in interface ValueDownlink<V>

Specified by:

laneUri in interface WarpDownlink

Specified by:

laneUri in class WarpDownlinkView

prio

public ValueDownlinkView<V> prio(float prio)

Specified by:

prio in interface ValueDownlink<V>

Specified by:

prio in interface WarpDownlink

Specified by:

prio in class WarpDownlinkView

rate

public ValueDownlinkView<V> rate(float rate)

Specified by:

rate in interface ValueDownlink<V>

Specified by:

rate in interface WarpDownlink

Specified by:

rate in class WarpDownlinkView

body

public ValueDownlinkView<V> body(Value body)

Specified by:

body in interface ValueDownlink<V>

Specified by:

body in interface WarpDownlink

Specified by:

body in class WarpDownlinkView

keepLinked

public ValueDownlinkView<V> keepLinked(boolean keepLinked)

Specified by:

keepLinked in interface ValueDownlink<V>

Specified by:

keepLinked in interface WarpDownlink

Specified by:

keepLinked in class WarpDownlinkView

keepSynced

public ValueDownlinkView<V> keepSynced(boolean keepSynced)

Specified by:

keepSynced in interface ValueDownlink<V>

Specified by:

keepSynced in interface WarpDownlink

Specified by:

keepSynced in class WarpDownlinkView

isStateful

public final boolean isStateful()

Specified by:

isStateful in interface ValueDownlink<V>

isStateful

public ValueDownlinkView<V> isStateful(boolean isStateful)

Specified by:

isStateful in interface ValueDownlink<V>

valueForm

public final Form<V> valueForm()

Specified by:

valueForm in interface ValueDownlink<V>

valueForm

public <V2> ValueDownlinkView<V2> valueForm(Form<V2> valueForm)

Specified by:

valueForm in interface ValueDownlink<V>

valueClass

public <V2> ValueDownlinkView<V2> valueClass(Class<V2> valueClass)

Specified by:

valueClass in interface ValueDownlink<V>

typesafeObservers

protected Object typesafeObservers(Object observers)

observe

public ValueDownlinkView<V> observe(Object observer)

Specified by:

observe in interface Downlink

Specified by:

observe in interface Link

Specified by:

observe in interface Observable<V>

Specified by:

observe in interface ObservableValue<V>

Specified by:

observe in interface ValueDownlink<V>

Specified by:

observe in interface WarpDownlink

Overrides:

observe in class WarpDownlinkView

unobserve

public ValueDownlinkView<V> unobserve(Object observer)

Specified by:

unobserve in interface Downlink

Specified by:

unobserve in interface Link

Specified by:

unobserve in interface Observable<V>

Specified by:

unobserve in interface ObservableValue<V>

Specified by:

unobserve in interface ValueDownlink<V>

Specified by:

unobserve in interface WarpDownlink

Overrides:

unobserve in class WarpDownlinkView

willSet

public ValueDownlinkView<V> willSet(WillSet<V> willSet)

Specified by:

willSet in interface ObservableValue<V>

Specified by:

willSet in interface ValueDownlink<V>

didSet

public ValueDownlinkView<V> didSet(DidSet<V> didSet)

Specified by:

didSet in interface ObservableValue<V>

Specified by:

didSet in interface ValueDownlink<V>

willReceive

public ValueDownlinkView<V> willReceive(WillReceive willReceive)

Specified by:

willReceive in interface ValueDownlink<V>

Specified by:

willReceive in interface WarpDownlink

Specified by:

willReceive in class WarpDownlinkView

didReceive

public ValueDownlinkView<V> didReceive(DidReceive didReceive)

Specified by:

didReceive in interface ValueDownlink<V>

Specified by:

didReceive in interface WarpDownlink

Specified by:

didReceive in class WarpDownlinkView

willCommand

public ValueDownlinkView<V> willCommand(WillCommand willCommand)

Specified by:

willCommand in interface ValueDownlink<V>

Specified by:

willCommand in interface WarpDownlink

Specified by:

willCommand in class WarpDownlinkView

willLink

public ValueDownlinkView<V> willLink(WillLink willLink)

Specified by:

willLink in interface ValueDownlink<V>

Specified by:

willLink in interface WarpDownlink

Specified by:

willLink in class WarpDownlinkView

didLink

public ValueDownlinkView<V> didLink(DidLink didLink)

Specified by:

didLink in interface ValueDownlink<V>

Specified by:

didLink in interface WarpDownlink

Specified by:

didLink in class WarpDownlinkView

willSync

public ValueDownlinkView<V> willSync(WillSync willSync)

Specified by:

willSync in interface ValueDownlink<V>

Specified by:

willSync in interface WarpDownlink

Specified by:

willSync in class WarpDownlinkView

didSync

public ValueDownlinkView<V> didSync(DidSync didSync)

Specified by:

didSync in interface ValueDownlink<V>

Specified by:

didSync in interface WarpDownlink

Specified by:

didSync in class WarpDownlinkView

willUnlink

public ValueDownlinkView<V> willUnlink(WillUnlink willUnlink)

Specified by:

willUnlink in interface ValueDownlink<V>

Specified by:

willUnlink in interface WarpDownlink

Specified by:

willUnlink in class WarpDownlinkView

didUnlink

public ValueDownlinkView<V> didUnlink(DidUnlink didUnlink)

Specified by:

didUnlink in interface ValueDownlink<V>

Specified by:

didUnlink in interface WarpDownlink

Specified by:

didUnlink in class WarpDownlinkView

didConnect

public ValueDownlinkView<V> didConnect(DidConnect didConnect)

Specified by:

didConnect in interface Downlink

Specified by:

didConnect in interface ValueDownlink<V>

Specified by:

didConnect in interface WarpDownlink

Specified by:

didConnect in class WarpDownlinkView

didDisconnect

public ValueDownlinkView<V> didDisconnect(DidDisconnect didDisconnect)

Specified by:

didDisconnect in interface Downlink

Specified by:

didDisconnect in interface ValueDownlink<V>

Specified by:

didDisconnect in interface WarpDownlink

Specified by:

didDisconnect in class WarpDownlinkView

didClose

public ValueDownlinkView<V> didClose(DidClose didClose)

Specified by:

didClose in interface Downlink

Specified by:

didClose in interface ValueDownlink<V>

Specified by:

didClose in interface WarpDownlink

Specified by:

didClose in class WarpDownlinkView

didFail

public ValueDownlinkView<V> didFail(DidFail didFail)

Specified by:

didFail in interface Downlink

Specified by:

didFail in interface ValueDownlink<V>

Specified by:

didFail in interface WarpDownlink

Specified by:

didFail in class WarpDownlinkView

dispatchWillSet

public Map.Entry<Boolean,V> dispatchWillSet(V newValue,
                                                  boolean preemptive)

dispatchDidSet

public boolean dispatchDidSet(V newValue,
                              V oldValue,
                              boolean preemptive)

downlinkWillSetValue

public Value downlinkWillSetValue(Value newValue)

downlinkDidSetValue

public void downlinkDidSetValue(Value newValue,
                                Value oldValue)

downlinkWillSet

public V downlinkWillSet(V newValue)

downlinkDidSet

public void downlinkDidSet(V newValue,
                           V oldValue)

createDownlinkModel

public ValueDownlinkModel createDownlinkModel()

Specified by:

createDownlinkModel in class WarpDownlinkView

open

public ValueDownlinkView<V> open()

Specified by:

open in interface Downlink

Specified by:

open in interface ValueDownlink<V>

Specified by:

open in interface WarpDownlink

Specified by:

open in class WarpDownlinkView

close

public void close()

Specified by:

close in interface Link

Overrides:

close in class DownlinkView

get

public V get()

Description copied from interface: Outlet

Returns the current state of this Outlet.

Specified by:

get in interface ObservableValue<V>

Specified by:

get in interface Outlet<V>

Specified by:

get in interface ValueDownlink<V>

set

public V set(V newValue)

Specified by:

set in interface ObservableValue<V>

Specified by:

set in interface ValueDownlink<V>

input

public Outlet<? extends V> input()

Description copied from interface: Inlet

Returns the Outlet from which this Inlet acquires its state; returns null if this Inlet is disconnected.

Specified by:

input in interface Inlet<V>

bindInput

public void bindInput(Outlet<? extends V> input)

Description copied from interface: Inlet

Connects this Inlet to an Outlet from which it will acquire its state. If this Inlet is already connected, it will first disconnect from its existing input. Then, after updating its input property, the Inlet will invoke Outlet.bindOutput(Inlet) on its new input.

Specified by:

bindInput in interface Inlet<V>

unbindInput

public void unbindInput()

Description copied from interface: Inlet

Disconnects this Inlet from its input Outlet, if connected. After setting its input property to null, the Inlet will invoke Outlet.unbindOutput(Inlet) on its old input, if defined.

Specified by:

unbindInput in interface Inlet<V>

disconnectInputs

public void disconnectInputs()

Description copied from interface: Inlet

Disconnects all Inlets dominated by this Inlet in the dataflow dependency graph. Used to recursively clean up chains of combinators terminating at this Inlet.

Specified by:

disconnectInputs in interface Inlet<V>

Specified by:

disconnectInputs in interface Outlet<V>

outputIterator

public Iterator<Inlet<? super V>> outputIterator()

Description copied from interface: Outlet

Returns an Iterator over the set of Inlets that depend on the state of this Outlet.

Specified by:

outputIterator in interface Outlet<V>

bindOutput

public void bindOutput(Inlet<? super V> output)

Description copied from interface: Outlet

Adds an output to the set of Inlets that depend on the state of this Outlet. The output will be decohered when the state of this Outlet is decohered, and recohered when this Outlet is recohered.

Specified by:

bindOutput in interface Outlet<V>

unbindOutput

public void unbindOutput(Inlet<? super V> output)

Description copied from interface: Outlet

Removes an output from the set of Inlets that depend on the state of this Outlet.

Specified by:

unbindOutput in interface Outlet<V>

unbindOutputs

public void unbindOutputs()

Description copied from interface: Outlet

Disconnects all outputs from this Outlet by invoking Inlet.unbindInput() on each Inelt that depends on the state of this Outlet.

Specified by:

unbindOutputs in interface Outlet<V>

disconnectOutputs

public void disconnectOutputs()

Description copied from interface: Inlet

Disconnects all Outlets dominated by this Inlet in the dataflow graph. Used to recursively clean up chains of combinators passing through this Inlet.

Specified by:

disconnectOutputs in interface Inlet<V>

Specified by:

disconnectOutputs in interface Outlet<V>

decohereOutput

public void decohereOutput()

Description copied from interface: Inlet

Marks this Inlet—and the Streamlet to which this Inlet is attached—as having decoherent state. Decohering an Inlet will recursively decohere all streamlets that transitively depend on the state of this Inlet. Decohering an Inlet does not cause its state to be recomputed. A subsequent Inlet.recohereOutput(int) call will eventually make the state of the Inlet coherent again.

Specified by:

decohereOutput in interface Inlet<V>

decohereInput

public void decohereInput()

Description copied from interface: Outlet

Marks this Outlet—and all outputs that depend on the state of this Outlet—as having decoherent state.

Specified by:

decohereInput in interface Outlet<V>

decohere

public void decohere()

recohereOutput

public void recohereOutput(int version)

Description copied from interface: Inlet

Updates the state of this Inlet to make it consistent with the target version. The Inlet only needs to update if its current version differs from the target version. To update its state, the Inlet first invokes Outlet.recohereInput(int) on its input, to ensure that its input is coherent. It then invokes Streamlet.recohere(int) on the Streamlet to which it's attached, causing the Streamlet to make its own state coherent again.

Specified by:

recohereOutput in interface Inlet<V>

recohereInput

public void recohereInput(int version)

Description copied from interface: Outlet

Updates the state of this Outlet to make it consistent with the target version. The Outlet only needs to update if its current version differs from the target version. To update its state, the Outlet first invokes Streamlet.recohere(int) on the Streamlet to which it's attached. It then invokes Inlet.recohereOutput(int) on each of its dependent outputs.

Specified by:

recohereInput in interface Outlet<V>

recohere

public void recohere(int version)

willDecohere

protected void willDecohere()

onDecohere

protected void onDecohere()

didDecohere

protected void didDecohere()

willRecohere

protected void willRecohere(int version)

onRecohere

protected void onRecohere(int version)

didRecohere

protected void didRecohere(int version)