org.openlcb.can.impl

Class OlcbConnection

java.lang.Object

org.openlcb.can.impl.OlcbConnection

public class OlcbConnection
extends Object

Created by bracz on 12/23/15.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OlcbConnection.CanFrameHub
static interface	OlcbConnection.ConnectionListener
private class	OlcbConnection.ListenerProxy Simple registry for connection listeners; proxies all calls to every single entry.

Field Summary

Fields

Modifier and Type	Field and Description
private CanInterface	canInterface
private String	hostName
private GridConnectInput	input
private OlcbConnection.CanFrameHub	inputHub
static OlcbConnection	lastConnection
private OlcbConnection.ListenerProxy	listenerProxy
private Runnable	mOnError
private NodeID	nodeId
private GridConnectOutput	output
private OlcbConnection.CanFrameHub	outputHub
private int	portNumber
private Socket	socket

Constructor Summary

Constructors

Constructor and Description
OlcbConnection(NodeID nodeId, String hostName, int portNumber, OlcbConnection.ConnectionListener connectionListener)

Method Summary

Modifier and Type	Method and Description
void	addConnectionListener(OlcbConnection.ConnectionListener l)
private void	connect()
void	dispose()
ConfigRepresentation	getConfigForNode(NodeID remoteNode) Creates a new or returns a cached CDI representation for the given node.
OlcbConnection.CanFrameHub	getInputHub()
OlcbInterface	getInterface()
OlcbConnection.CanFrameHub	getOutputHub()
void	removeConnectionListener(OlcbConnection.ConnectionListener l) Removes a listener.
void	shutdown()
void	startConnect()

Methods inherited from class java.lang.Object

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

Field Detail

lastConnection

public static OlcbConnection lastConnection

nodeId

private final NodeID nodeId

listenerProxy

private final OlcbConnection.ListenerProxy listenerProxy

hostName

private String hostName

portNumber

private int portNumber

input

private GridConnectInput input

output

private GridConnectOutput output

inputHub

private OlcbConnection.CanFrameHub inputHub

outputHub

private OlcbConnection.CanFrameHub outputHub

canInterface

private CanInterface canInterface

socket

private Socket socket

mOnError

private Runnable mOnError

Constructor Detail

OlcbConnection

public OlcbConnection(NodeID nodeId,
                      String hostName,
                      int portNumber,
                      OlcbConnection.ConnectionListener connectionListener)

Method Detail

startConnect

public void startConnect()

connect

private void connect()

shutdown

public void shutdown()

addConnectionListener

public void addConnectionListener(OlcbConnection.ConnectionListener l)

removeConnectionListener

public void removeConnectionListener(OlcbConnection.ConnectionListener l)

Removes a listener. It is okay to call this from inside a connectionlistener callback.

Parameters:

l - listener to remove

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)

getInputHub

public OlcbConnection.CanFrameHub getInputHub()

Returns:

the CAN frame hub processing the incoming messages (from the network; sent by other nodes).

This can be used for two purposes: - get a copy of all frames arriving from the network; - inject fake messages as if they were coming from the network (not super useful).

getOutputHub

public OlcbConnection.CanFrameHub getOutputHub()

Returns:

the CAN frame hub processing outgoing messages (to the network; originating from this node).

This can be used for two purposes: - send packets to the network - get a copy of (aka sniff) all outgoing packets before they are sent.

getInterface

public OlcbInterface getInterface()

dispose

public void dispose()