OlcbInterface (OpenLCB 0.7.21 API)

java.lang.Object
- org.openlcb.OlcbInterface

```
public class OlcbInterface
extends Object
```
Collects all objects necessary to run an OpenLCB standards-compatible interface.
Created by bracz on 12/27/15.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`OlcbInterface.MessageDispatcher`
`(package private) class`	`OlcbInterface.OutputConnectionSniffer` Performs local feedback of addressed and global messages.
`private class`	`OlcbInterface.QueuedOutputConnection` This class keeps an output connection operating using an internal queue.
`static interface`	`OlcbInterface.SyncExecutor` Implement this interface if you need to control the thread on which loopback messages are executed.

Field Summary

Fields
Modifier and Type	Field and Description
`private DatagramService`	`dcs`
`private DatagramMeteringBuffer`	`dmb`
`private EventTable`	`eventTable`
`private OlcbInterface.MessageDispatcher`	`inputConnection`
`protected Connection`	`internalOutputConnection`
`private static Logger`	`log`
`private OlcbInterface.SyncExecutor`	`loopbackThread`
`(package private) static int`	`maxThreads`
`private MemoryConfigurationService`	`mcs`
`(package private) static int`	`minThreads`
`private Map<NodeID,ConfigRepresentation>`	`nodeConfigs`
`private NodeID`	`nodeId`
`private MimicNodeStore`	`nodeStore`
`protected Connection`	`outputConnection`
`private OlcbInterface.QueuedOutputConnection`	`queuedOutputConnection`
`private ThreadPoolExecutor`	`threadPool`
`(package private) static long`	`threadTimeout`
`private Timer`	`timer`
`private OlcbInterface.OutputConnectionSniffer`	`wrappedOutputConnection`

Constructor Summary

Constructors
Constructor and Description
`OlcbInterface(NodeID nodeId_, Connection outputConnection_)` Deprecated. since OlcbLibrary version 0.18. Use `OlcbInterface(NodeID, Connection, ThreadPoolExecutor)` instead.
`OlcbInterface(NodeID nodeId_, Connection outputConnection_, ThreadPoolExecutor tpe)` Creates the message-level interface.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`dispose()` cleanup local resources
`void`	`flushSendQueue()` Blocks the current thread until the outgoing messages are all sent out.
`ConfigRepresentation`	`getConfigForNode(NodeID remoteNode)` Creates a new or returns a cached CDI representation for the given node.
`DatagramMeteringBuffer`	`getDatagramMeteringBuffer()`
`DatagramService`	`getDatagramService()`
`EventTable`	`getEventTable()`
`Connection`	`getInputConnection()` Accessor for the outside interface for arriving inbound messages.
`MemoryConfigurationService`	`getMemoryConfigurationService()`
`NodeID`	`getNodeId()`
`MimicNodeStore`	`getNodeStore()`
`Connection`	`getOutputConnection()` Accessor for client libraries to send messages out.
`Timer`	`getTimer()`
`void`	`injectMemoryConfigurationService(MemoryConfigurationService s)`
`int`	`numMessageListeners()`
`void`	`registerMessageListener(Connection c)`
`(package private) void`	`runCallbackOrAbandon(Runnable r)` Calls a piece of code on the loopback thread.
`void`	`runOnThreadPool(Runnable r)` Schedules work on an interface-internal thread.
`void`	`setLoopbackThread(OlcbInterface.SyncExecutor thread)` Force the stack to execute all loopback messages on a given thread.
`void`	`unRegisterMessageListener(Connection c)`

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

- Field Detail
  - log
```
private static final Logger log
```
  - timer
```
private final Timer timer
```
  - internalOutputConnection
```
protected final Connection internalOutputConnection
```
  - outputConnection
```
protected final Connection outputConnection
```
  - wrappedOutputConnection
```
private final OlcbInterface.OutputConnectionSniffer wrappedOutputConnection
```
  - queuedOutputConnection
```
private final OlcbInterface.QueuedOutputConnection queuedOutputConnection
```
  - inputConnection
```
private final OlcbInterface.MessageDispatcher inputConnection
```
  - nodeId
```
private final NodeID nodeId
```
  - nodeStore
```
private final MimicNodeStore nodeStore
```
  - dmb
```
private final DatagramMeteringBuffer dmb
```
  - dcs
```
private final DatagramService dcs
```
  - mcs
```
private MemoryConfigurationService mcs
```
  - nodeConfigs
```
private final Map<NodeID,ConfigRepresentation> nodeConfigs
```
  - eventTable
```
private EventTable eventTable
```
  - threadPool
```
private ThreadPoolExecutor threadPool
```
  - minThreads
```
static final int minThreads
```
    See Also:
    
    Constant Field Values
  - maxThreads
```
static final int maxThreads
```
    See Also:
    
    Constant Field Values
  - threadTimeout
```
static final long threadTimeout
```
    See Also:
    
    Constant Field Values
  - loopbackThread
```
private OlcbInterface.SyncExecutor loopbackThread
```
- Constructor Detail
  - OlcbInterface
```
@Deprecated
public OlcbInterface(NodeID nodeId_,
                                 Connection outputConnection_)
```
    Deprecated. since OlcbLibrary version 0.18. Use OlcbInterface(NodeID, Connection, ThreadPoolExecutor) instead.
    
    Creates the message-level interface.
    
    Parameters:
    
    nodeId_ - is the node ID for the node on this interface. Will send out a node initialized ready with this node ID.
    
    outputConnection_ - implements the hardware interface for sending messages to the network. Usually this is an internal object of the CanInterface.
  - OlcbInterface
```
public OlcbInterface(NodeID nodeId_,
                     Connection outputConnection_,
                     ThreadPoolExecutor tpe)
```
    Creates the message-level interface.
    
    Parameters:
    
    nodeId_ - is the node ID for the node on this interface. Will send out a node initialized ready with this node ID.
    
    outputConnection_ - implements the hardware interface for sending messages to the network. Usually this is an internal object of the CanInterface.
    
    tpe - ThreadPoolExecutor for the interface.
- Method Detail
  - setLoopbackThread
```
public void setLoopbackThread(OlcbInterface.SyncExecutor thread)
```
    Force the stack to execute all loopback messages on a given thread. Programs using the library in a single-threaded manner can cause all callbacks to execute on that thread by calling this function.
    
    Parameters:
    
    thread - Implementation to jump to the desired thread.
  - runOnThreadPool
```
public void runOnThreadPool(Runnable r)
```
    Schedules work on an interface-internal thread. This thread will be cancelled during the interface shutdown.
    
    Parameters:
    
    r - work to run.
  - getTimer
```
public Timer getTimer()
```
    Returns:
    
    a shared Timer thread to be used by all components in this interface. Tasks scheduled on this timer are not allowed to block (as it's a shared timer thread).
  - getInputConnection
```
public Connection getInputConnection()
```
    Accessor for the outside interface for arriving inbound messages.
    
    Returns:
    
    the Connection that the incoming messages (from the network) have to be forwarded to.
  - getOutputConnection
```
public Connection getOutputConnection()
```
    Accessor for client libraries to send messages out.
    
    Returns:
    
    the connection through which to send messages to the bus.
  - getNodeId
```
public NodeID getNodeId()
```
  - getNodeStore
```
public MimicNodeStore getNodeStore()
```
  - getDatagramService
```
public DatagramService getDatagramService()
```
  - getDatagramMeteringBuffer
```
public DatagramMeteringBuffer getDatagramMeteringBuffer()
```
  - getMemoryConfigurationService
```
public MemoryConfigurationService getMemoryConfigurationService()
```
  - injectMemoryConfigurationService
```
public void injectMemoryConfigurationService(MemoryConfigurationService s)
```
  - getEventTable
```
public EventTable getEventTable()
```
  - getConfigForNode
```
public ConfigRepresentation getConfigForNode(NodeID remoteNode)
```
    Creates a new or returns a cached CDI representation for the given node.
    
    Parameters:
    
    remoteNode - target node (on the network)
    
    Returns:
    
    the cached CDI representation for that node (may be newly created and thus empty)
  - flushSendQueue
```
public void flushSendQueue()
```
    Blocks the current thread until the outgoing messages are all sent out. Useful for testing.
  - registerMessageListener
```
public void registerMessageListener(Connection c)
```
  - unRegisterMessageListener
```
public void unRegisterMessageListener(Connection c)
```
  - numMessageListeners
```
public int numMessageListeners()
```
    Returns:
    
    how many listeners are currently registered using registerMessageListener.
  - runCallbackOrAbandon
```
void runCallbackOrAbandon(Runnable r)
```
    Calls a piece of code on the loopback thread. If we are interrupted, abandons the call.
    
    Parameters:
    
    r - Stuff to run on loopback thread.
  - dispose
```
public void dispose()
```
    cleanup local resources

Class OlcbInterface

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

timer

internalOutputConnection

outputConnection

wrappedOutputConnection

queuedOutputConnection

inputConnection

nodeId

nodeStore

dmb

dcs

mcs

nodeConfigs

eventTable

threadPool

minThreads

maxThreads

threadTimeout

loopbackThread

Constructor Detail

OlcbInterface

OlcbInterface

Method Detail

setLoopbackThread

runOnThreadPool

getTimer

getInputConnection

getOutputConnection

getNodeId

getNodeStore

getDatagramService

getDatagramMeteringBuffer

getMemoryConfigurationService

injectMemoryConfigurationService

getEventTable

getConfigForNode

flushSendQueue

registerMessageListener

unRegisterMessageListener

numMessageListeners

runCallbackOrAbandon

dispose