java.lang.Object
- swim.runtime.uplink.UplinkModem

All Implemented Interfaces:

swim.api.Link, swim.api.uplink.Uplink, swim.observable.Observable<Object>, LinkContext, swim.util.Log

Direct Known Subclasses:

DemandUplinkModem, PartialUplinkModem, SupplyUplinkModem
```
public abstract class UplinkModem
extends Object
implements LinkContext, swim.api.uplink.Uplink
```

Field Summary

Fields
Modifier and Type Field Description

protected LinkBinding linkBinding

protected swim.structure.Value linkKey

protected Object observers

protected int status

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`swim.structure.Value`	`body()`
`String`	`cipherSuite()`
`String`	`cipherSuiteUp()`
`void`	`close()`
`void`	`closeUp()`
`void`	`cueDown()`
`void`	`cueUp()`
`void`	`debug(Object message)`
`void`	`debugUp(Object message)`
`UplinkModem`	`didClose(swim.api.function.DidClose didClose)`
`void`	`didCloseDown()`
`protected void`	`didFail(Throwable error)`
`protected void`	`didLink(swim.warp.LinkedResponse response)`
`void`	`didOpenDown()`
`protected void`	`didSync(swim.warp.SyncedResponse response)`
`protected void`	`didUnlink(swim.warp.UnlinkedResponse response)`
`protected void`	`dispatchDidClose()`
`protected boolean`	`dispatchOnCommand(swim.warp.CommandMessage message, boolean preemptive)`
`protected void`	`dispatchOnEvent(swim.warp.EventMessage message)`
`protected boolean`	`dispatchOnLink(swim.warp.LinkRequest request, boolean preemptive)`
`protected void`	`dispatchOnLinked(swim.warp.LinkedResponse response)`
`protected boolean`	`dispatchOnSync(swim.warp.SyncRequest request, boolean preemptive)`
`protected void`	`dispatchOnSynced(swim.warp.SyncedResponse response)`
`protected boolean`	`dispatchOnUnlink(swim.warp.UnlinkRequest request, boolean preemptive)`
`protected void`	`dispatchOnUnlinked(swim.warp.UnlinkedResponse response)`
`protected boolean`	`downQueueIsEmpty()`
`void`	`error(Object message)`
`void`	`errorUp(Object message)`
`void`	`feedUp()`
`swim.uri.Uri`	`hostUri()`
`void`	`info(Object message)`
`void`	`infoUp(Object message)`
`boolean`	`isConnected()`
`boolean`	`isConnectedUp()`
`boolean`	`isRemote()`
`boolean`	`isRemoteUp()`
`boolean`	`isSecure()`
`boolean`	`isSecureUp()`
`abstract LaneBinding`	`laneBinding()`
`swim.uri.Uri`	`laneUri()`
`LinkBinding`	`linkBinding()`
`protected swim.warp.LinkedResponse`	`linkedResponse()`
`swim.structure.Value`	`linkKey()`
`InetSocketAddress`	`localAddress()`
`InetSocketAddress`	`localAddressUp()`
`Collection<Certificate>`	`localCertificates()`
`Collection<Certificate>`	`localCertificatesUp()`
`swim.api.auth.Identity`	`localIdentity()`
`swim.api.auth.Identity`	`localIdentityUp()`
`Principal`	`localPrincipal()`
`Principal`	`localPrincipalUp()`
`protected swim.structure.Value`	`nextDownCue()`
`protected swim.warp.EventMessage`	`nextDownCueEvent()`
`protected swim.structure.Value`	`nextDownQueue()`
`protected swim.warp.EventMessage`	`nextDownQueueEvent()`
`swim.uri.Uri`	`nodeUri()`
`UplinkModem`	`observe(Object newObserver)`
`UplinkModem`	`onCommand(swim.api.uplink.function.OnCommand onCommand)`
`protected void`	`onCommand(swim.warp.CommandMessage message)`
`UplinkModem`	`onEvent(swim.api.uplink.function.OnEvent onEvent)`
`protected void`	`onEvent(swim.warp.EventMessage message)`
`UplinkModem`	`onLink(swim.api.uplink.function.OnLink onLink)`
`UplinkModem`	`onLinked(swim.api.uplink.function.OnLinked onLinked)`
`UplinkModem`	`onSync(swim.api.uplink.function.OnSync onSync)`
`UplinkModem`	`onSynced(swim.api.uplink.function.OnSynced onSynced)`
`UplinkModem`	`onUnlink(swim.api.uplink.function.OnUnlink onUnlink)`
`UplinkModem`	`onUnlinked(swim.api.uplink.function.OnUnlinked onUnlinked)`
`float`	`prio()`
`void`	`pullDown()`
`protected void`	`pullDownEnvelope()`
`protected void`	`pullDownEvent(swim.warp.EventMessage message)`
`protected void`	`pullDownLinked(swim.warp.LinkedResponse response)`
`protected void`	`pullDownSynced(swim.warp.SyncedResponse response)`
`protected void`	`pullDownUnlinked(swim.warp.UnlinkedResponse response)`
`void`	`pushUp(swim.warp.Envelope envelope)`
`protected void`	`pushUpCommand(swim.warp.CommandMessage message)`
`protected void`	`pushUpEnvelope(swim.warp.Envelope envelope)`
`protected void`	`pushUpLink(swim.warp.LinkRequest request)`
`protected void`	`pushUpSync(swim.warp.SyncRequest request)`
`protected void`	`pushUpUnlink(swim.warp.UnlinkRequest request)`
`protected void`	`queueDown(swim.structure.Value body)`
`float`	`rate()`
`InetSocketAddress`	`remoteAddress()`
`InetSocketAddress`	`remoteAddressUp()`
`Collection<Certificate>`	`remoteCertificates()`
`Collection<Certificate>`	`remoteCertificatesUp()`
`swim.api.auth.Identity`	`remoteIdentity()`
`swim.api.auth.Identity`	`remoteIdentityUp()`
`Principal`	`remotePrincipal()`
`Principal`	`remotePrincipalUp()`
`protected void`	`runOnCommand(swim.warp.CommandMessage message)`
`protected void`	`runOnLink(swim.warp.LinkRequest request)`
`protected void`	`runOnSync(swim.warp.SyncRequest request)`
`protected void`	`runOnUnlink(swim.warp.UnlinkRequest request)`
`protected void`	`runPullDown()`
`String`	`securityProtocol()`
`String`	`securityProtocolUp()`
`void`	`sendDown(swim.structure.Value body)`
`void`	`skipUp()`
`abstract swim.concurrent.Stage`	`stage()`
`protected swim.warp.SyncedResponse`	`syncedResponse()`
`void`	`trace(Object message)`
`void`	`traceUp(Object message)`
`void`	`unlink()`
`protected swim.warp.UnlinkedResponse`	`unlinkedResponse()`
`UplinkModem`	`unobserve(Object oldObserver)`
`void`	`warn(Object message)`
`void`	`warnUp(Object message)`
`protected void`	`willLink(swim.warp.LinkRequest request)`
`protected void`	`willSync(swim.warp.SyncRequest request)`
`protected void`	`willUnlink(swim.warp.UnlinkRequest request)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

linkBinding

protected final LinkBinding linkBinding

linkKey

protected final swim.structure.Value linkKey

status
```
protected volatile int status
```

observers
```
protected volatile Object observers
```

Method Detail
- laneBinding
```
public abstract LaneBinding laneBinding()
```
- linkBinding
```
public final LinkBinding linkBinding()
```
- stage
```
public abstract swim.concurrent.Stage stage()
```
- hostUri
```
public final swim.uri.Uri hostUri()
```
  Specified by:
  
  hostUri in interface swim.api.Link
  
  Specified by:
  
  hostUri in interface swim.api.uplink.Uplink
- nodeUri
```
public final swim.uri.Uri nodeUri()
```
  Specified by:
  
  nodeUri in interface swim.api.Link
  
  Specified by:
  
  nodeUri in interface swim.api.uplink.Uplink
- laneUri
```
public final swim.uri.Uri laneUri()
```
  Specified by:
  
  laneUri in interface swim.api.Link
  
  Specified by:
  
  laneUri in interface swim.api.uplink.Uplink
- linkKey
```
public final swim.structure.Value linkKey()
```
  Specified by:
  
  linkKey in interface LinkContext
- prio
```
public final float prio()
```
  Specified by:
  
  prio in interface swim.api.uplink.Uplink
- rate
```
public final float rate()
```
  Specified by:
  
  rate in interface swim.api.uplink.Uplink
- body
```
public final swim.structure.Value body()
```
  Specified by:
  
  body in interface swim.api.uplink.Uplink
- isConnectedUp
```
public boolean isConnectedUp()
```
  Specified by:
  
  isConnectedUp in interface LinkContext
- isRemoteUp
```
public boolean isRemoteUp()
```
  Specified by:
  
  isRemoteUp in interface LinkContext
- isSecureUp
```
public boolean isSecureUp()
```
  Specified by:
  
  isSecureUp in interface LinkContext
- securityProtocolUp
```
public String securityProtocolUp()
```
  Specified by:
  
  securityProtocolUp in interface LinkContext
- cipherSuiteUp
```
public String cipherSuiteUp()
```
  Specified by:
  
  cipherSuiteUp in interface LinkContext
- localAddressUp
```
public InetSocketAddress localAddressUp()
```
  Specified by:
  
  localAddressUp in interface LinkContext
- localIdentityUp
```
public swim.api.auth.Identity localIdentityUp()
```
  Specified by:
  
  localIdentityUp in interface LinkContext
- localPrincipalUp
```
public Principal localPrincipalUp()
```
  Specified by:
  
  localPrincipalUp in interface LinkContext
- localCertificatesUp
```
public Collection<Certificate> localCertificatesUp()
```
  Specified by:
  
  localCertificatesUp in interface LinkContext
- remoteAddressUp
```
public InetSocketAddress remoteAddressUp()
```
  Specified by:
  
  remoteAddressUp in interface LinkContext
- remoteIdentityUp
```
public swim.api.auth.Identity remoteIdentityUp()
```
  Specified by:
  
  remoteIdentityUp in interface LinkContext
- remotePrincipalUp
```
public Principal remotePrincipalUp()
```
  Specified by:
  
  remotePrincipalUp in interface LinkContext
- remoteCertificatesUp
```
public Collection<Certificate> remoteCertificatesUp()
```
  Specified by:
  
  remoteCertificatesUp in interface LinkContext
- isConnected
```
public boolean isConnected()
```
  Specified by:
  
  isConnected in interface swim.api.Link
  
  Specified by:
  
  isConnected in interface swim.api.uplink.Uplink
- isRemote
```
public boolean isRemote()
```
  Specified by:
  
  isRemote in interface swim.api.Link
  
  Specified by:
  
  isRemote in interface swim.api.uplink.Uplink
- isSecure
```
public boolean isSecure()
```
  Specified by:
  
  isSecure in interface swim.api.Link
  
  Specified by:
  
  isSecure in interface swim.api.uplink.Uplink
- securityProtocol
```
public String securityProtocol()
```
  Specified by:
  
  securityProtocol in interface swim.api.Link
  
  Specified by:
  
  securityProtocol in interface swim.api.uplink.Uplink
- cipherSuite
```
public String cipherSuite()
```
  Specified by:
  
  cipherSuite in interface swim.api.Link
  
  Specified by:
  
  cipherSuite in interface swim.api.uplink.Uplink
- localAddress
```
public InetSocketAddress localAddress()
```
  Specified by:
  
  localAddress in interface swim.api.Link
  
  Specified by:
  
  localAddress in interface swim.api.uplink.Uplink
- localIdentity
```
public swim.api.auth.Identity localIdentity()
```
  Specified by:
  
  localIdentity in interface swim.api.Link
  
  Specified by:
  
  localIdentity in interface swim.api.uplink.Uplink
- localPrincipal
```
public Principal localPrincipal()
```
  Specified by:
  
  localPrincipal in interface swim.api.Link
  
  Specified by:
  
  localPrincipal in interface swim.api.uplink.Uplink
- localCertificates
```
public Collection<Certificate> localCertificates()
```
  Specified by:
  
  localCertificates in interface swim.api.Link
  
  Specified by:
  
  localCertificates in interface swim.api.uplink.Uplink
- remoteAddress
```
public InetSocketAddress remoteAddress()
```
  Specified by:
  
  remoteAddress in interface swim.api.Link
  
  Specified by:
  
  remoteAddress in interface swim.api.uplink.Uplink
- remoteIdentity
```
public swim.api.auth.Identity remoteIdentity()
```
  Specified by:
  
  remoteIdentity in interface swim.api.Link
  
  Specified by:
  
  remoteIdentity in interface swim.api.uplink.Uplink
- remotePrincipal
```
public Principal remotePrincipal()
```
  Specified by:
  
  remotePrincipal in interface swim.api.Link
  
  Specified by:
  
  remotePrincipal in interface swim.api.uplink.Uplink
- remoteCertificates
```
public Collection<Certificate> remoteCertificates()
```
  Specified by:
  
  remoteCertificates in interface swim.api.Link
  
  Specified by:
  
  remoteCertificates in interface swim.api.uplink.Uplink
- observe
```
public UplinkModem observe(Object newObserver)
```
  Specified by:
  
  observe in interface swim.api.Link
  
  Specified by:
  
  observe in interface swim.observable.Observable<Object>
  
  Specified by:
  
  observe in interface swim.api.uplink.Uplink
- unobserve
```
public UplinkModem unobserve(Object oldObserver)
```
  Specified by:
  
  unobserve in interface swim.api.Link
  
  Specified by:
  
  unobserve in interface swim.observable.Observable<Object>
  
  Specified by:
  
  unobserve in interface swim.api.uplink.Uplink
- onEvent
```
public UplinkModem onEvent(swim.api.uplink.function.OnEvent onEvent)
```
  Specified by:
  
  onEvent in interface swim.api.uplink.Uplink
- onCommand
```
public UplinkModem onCommand(swim.api.uplink.function.OnCommand onCommand)
```
  Specified by:
  
  onCommand in interface swim.api.uplink.Uplink
- onLink
```
public UplinkModem onLink(swim.api.uplink.function.OnLink onLink)
```
  Specified by:
  
  onLink in interface swim.api.uplink.Uplink
- onLinked
```
public UplinkModem onLinked(swim.api.uplink.function.OnLinked onLinked)
```
  Specified by:
  
  onLinked in interface swim.api.uplink.Uplink
- onSync
```
public UplinkModem onSync(swim.api.uplink.function.OnSync onSync)
```
  Specified by:
  
  onSync in interface swim.api.uplink.Uplink
- onSynced
```
public UplinkModem onSynced(swim.api.uplink.function.OnSynced onSynced)
```
  Specified by:
  
  onSynced in interface swim.api.uplink.Uplink
- onUnlink
```
public UplinkModem onUnlink(swim.api.uplink.function.OnUnlink onUnlink)
```
  Specified by:
  
  onUnlink in interface swim.api.uplink.Uplink
- onUnlinked
```
public UplinkModem onUnlinked(swim.api.uplink.function.OnUnlinked onUnlinked)
```
  Specified by:
  
  onUnlinked in interface swim.api.uplink.Uplink
- didClose
```
public UplinkModem didClose(swim.api.function.DidClose didClose)
```
  Specified by:
  
  didClose in interface swim.api.uplink.Uplink
- dispatchOnEvent
```
protected void dispatchOnEvent(swim.warp.EventMessage message)
```
- dispatchOnCommand
```
protected boolean dispatchOnCommand(swim.warp.CommandMessage message,
                                    boolean preemptive)
```
- dispatchOnLink
```
protected boolean dispatchOnLink(swim.warp.LinkRequest request,
                                 boolean preemptive)
```
- dispatchOnLinked
```
protected void dispatchOnLinked(swim.warp.LinkedResponse response)
```
- dispatchOnSync
```
protected boolean dispatchOnSync(swim.warp.SyncRequest request,
                                 boolean preemptive)
```
- dispatchOnSynced
```
protected void dispatchOnSynced(swim.warp.SyncedResponse response)
```
- dispatchOnUnlink
```
protected boolean dispatchOnUnlink(swim.warp.UnlinkRequest request,
                                   boolean preemptive)
```
- dispatchOnUnlinked
```
protected void dispatchOnUnlinked(swim.warp.UnlinkedResponse response)
```
- dispatchDidClose
```
protected void dispatchDidClose()
```
- downQueueIsEmpty
```
protected boolean downQueueIsEmpty()
```
- queueDown
```
protected void queueDown(swim.structure.Value body)
```
- nextDownQueue
```
protected swim.structure.Value nextDownQueue()
```
- nextDownQueueEvent
```
protected swim.warp.EventMessage nextDownQueueEvent()
```
- nextDownCue
```
protected swim.structure.Value nextDownCue()
```
- nextDownCueEvent
```
protected swim.warp.EventMessage nextDownCueEvent()
```
- sendDown
```
public void sendDown(swim.structure.Value body)
```
- cueDown
```
public void cueDown()
```
- pullDown
```
public void pullDown()
```
  Specified by:
  
  pullDown in interface LinkContext
- runPullDown
```
protected void runPullDown()
```
- pullDownEnvelope
```
protected void pullDownEnvelope()
```
- pullDownEvent
```
protected void pullDownEvent(swim.warp.EventMessage message)
```
- pullDownLinked
```
protected void pullDownLinked(swim.warp.LinkedResponse response)
```
- pullDownSynced
```
protected void pullDownSynced(swim.warp.SyncedResponse response)
```
- pullDownUnlinked
```
protected void pullDownUnlinked(swim.warp.UnlinkedResponse response)
```
- cueUp
```
public void cueUp()
```
- feedUp
```
public void feedUp()
```
  Specified by:
  
  feedUp in interface LinkContext
- pushUp
```
public void pushUp(swim.warp.Envelope envelope)
```
  Specified by:
  
  pushUp in interface LinkContext
- pushUpCommand
```
protected void pushUpCommand(swim.warp.CommandMessage message)
```
- runOnCommand
```
protected void runOnCommand(swim.warp.CommandMessage message)
```
- pushUpLink
```
protected void pushUpLink(swim.warp.LinkRequest request)
```
- runOnLink
```
protected void runOnLink(swim.warp.LinkRequest request)
```
- pushUpSync
```
protected void pushUpSync(swim.warp.SyncRequest request)
```
- runOnSync
```
protected void runOnSync(swim.warp.SyncRequest request)
```
- pushUpUnlink
```
protected void pushUpUnlink(swim.warp.UnlinkRequest request)
```
- runOnUnlink
```
protected void runOnUnlink(swim.warp.UnlinkRequest request)
```
- pushUpEnvelope
```
protected void pushUpEnvelope(swim.warp.Envelope envelope)
```
- skipUp
```
public void skipUp()
```
  Specified by:
  
  skipUp in interface LinkContext
- unlink
```
public void unlink()
```
- closeUp
```
public void closeUp()
```
  Specified by:
  
  closeUp in interface LinkContext
- close
```
public void close()
```
  Specified by:
  
  close in interface swim.api.Link
  
  Specified by:
  
  close in interface swim.api.uplink.Uplink
- didOpenDown
```
public void didOpenDown()
```
  Specified by:
  
  didOpenDown in interface LinkContext
- didCloseDown
```
public void didCloseDown()
```
  Specified by:
  
  didCloseDown in interface LinkContext
- onEvent
```
protected void onEvent(swim.warp.EventMessage message)
```
- onCommand
```
protected void onCommand(swim.warp.CommandMessage message)
```
- willLink
```
protected void willLink(swim.warp.LinkRequest request)
```
- didLink
```
protected void didLink(swim.warp.LinkedResponse response)
```
- willSync
```
protected void willSync(swim.warp.SyncRequest request)
```
- didSync
```
protected void didSync(swim.warp.SyncedResponse response)
```
- willUnlink
```
protected void willUnlink(swim.warp.UnlinkRequest request)
```
- didUnlink
```
protected void didUnlink(swim.warp.UnlinkedResponse response)
```
- didFail
```
protected void didFail(Throwable error)
```
- linkedResponse
```
protected swim.warp.LinkedResponse linkedResponse()
```
- syncedResponse
```
protected swim.warp.SyncedResponse syncedResponse()
```
- unlinkedResponse
```
protected swim.warp.UnlinkedResponse unlinkedResponse()
```
- traceUp
```
public void traceUp(Object message)
```
  Specified by:
  
  traceUp in interface LinkContext
- debugUp
```
public void debugUp(Object message)
```
  Specified by:
  
  debugUp in interface LinkContext
- infoUp
```
public void infoUp(Object message)
```
  Specified by:
  
  infoUp in interface LinkContext
- warnUp
```
public void warnUp(Object message)
```
  Specified by:
  
  warnUp in interface LinkContext
- errorUp
```
public void errorUp(Object message)
```
  Specified by:
  
  errorUp in interface LinkContext
- trace
```
public void trace(Object message)
```
  Specified by:
  
  trace in interface swim.api.Link
  
  Specified by:
  
  trace in interface swim.util.Log
  
  Specified by:
  
  trace in interface swim.api.uplink.Uplink
- debug
```
public void debug(Object message)
```
  Specified by:
  
  debug in interface swim.api.Link
  
  Specified by:
  
  debug in interface swim.util.Log
  
  Specified by:
  
  debug in interface swim.api.uplink.Uplink
- info
```
public void info(Object message)
```
  Specified by:
  
  info in interface swim.api.Link
  
  Specified by:
  
  info in interface swim.util.Log
  
  Specified by:
  
  info in interface swim.api.uplink.Uplink
- warn
```
public void warn(Object message)
```
  Specified by:
  
  warn in interface swim.api.Link
  
  Specified by:
  
  warn in interface swim.util.Log
  
  Specified by:
  
  warn in interface swim.api.uplink.Uplink
- error
```
public void error(Object message)
```
  Specified by:
  
  error in interface swim.api.Link
  
  Specified by:
  
  error in interface swim.util.Log
  
  Specified by:
  
  error in interface swim.api.uplink.Uplink

Modifier and Type	Field	Description
`protected LinkBinding`	`linkBinding`
`protected swim.structure.Value`	`linkKey`
`protected Object`	`observers`
`protected int`	`status`

Class UplinkModem

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

linkBinding

linkKey

status

observers

Method Detail

laneBinding

linkBinding

stage

hostUri

nodeUri

laneUri

linkKey

prio

rate

body

isConnectedUp

isRemoteUp

isSecureUp

securityProtocolUp

cipherSuiteUp

localAddressUp

localIdentityUp

localPrincipalUp

localCertificatesUp

remoteAddressUp

remoteIdentityUp

remotePrincipalUp

remoteCertificatesUp

isConnected

isRemote

isSecure

securityProtocol

cipherSuite

localAddress

localIdentity

localPrincipal

localCertificates

remoteAddress

remoteIdentity

remotePrincipal

remoteCertificates

observe

unobserve

onEvent

onCommand

onLink

onLinked

onSync

onSynced

onUnlink

onUnlinked

didClose

dispatchOnEvent

dispatchOnCommand

dispatchOnLink

dispatchOnLinked

dispatchOnSync

dispatchOnSynced

dispatchOnUnlink

dispatchOnUnlinked

dispatchDidClose

downQueueIsEmpty

queueDown

nextDownQueue

nextDownQueueEvent

nextDownCue

nextDownCueEvent

sendDown

cueDown

pullDown

runPullDown

pullDownEnvelope

pullDownEvent

pullDownLinked

pullDownSynced