org.openlcb

Class OlcbInterface

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.

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 MemoryConfigurationService	mcs
private Map<NodeID,ConfigRepresentation>	nodeConfigs
private NodeID	nodeId
private MimicNodeStore	nodeStore
protected Connection	outputConnection
private OlcbInterface.QueuedOutputConnection	queuedOutputConnection
private OlcbInterface.OutputConnectionSniffer	wrappedOutputConnection

Constructor Summary

Constructors

Constructor and Description
OlcbInterface(NodeID nodeId_, Connection outputConnection_) Creates the message-level interface.

Method Summary

Modifier and Type	Method and Description
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.
void	injectMemoryConfigurationService(MemoryConfigurationService s)
void	registerMessageListener(Connection c)
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

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

Constructor Detail

OlcbInterface

public OlcbInterface(NodeID nodeId_,
                     Connection outputConnection_)

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.

Method Detail

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)