com.moppy.core.comms.bridge

Class NetworkBridge<CONNOPTION>

java.lang.Object

com.moppy.core.comms.bridge.NetworkBridge<CONNOPTION>

All Implemented Interfaces:

NetworkMessageConsumer, Closeable, AutoCloseable

Direct Known Subclasses:

BridgeSerial, BridgeUDP, MultiBridge

public abstract class NetworkBridge<CONNOPTION>
extends Object
implements Closeable, NetworkMessageConsumer

Interface for a particular form of the Moppy network; used for sending and receiving MoppyMessages.

Constructor Summary

Constructors

Constructor and Description
NetworkBridge()

Method Summary

Modifier and Type	Method and Description
void	acceptNetworkMessage(NetworkReceivedMessage messageReceived) Called by network leaves to pass messages from the network.
abstract void	connect()
abstract void	connect(CONNOPTION connectionOption)
abstract CONNOPTION	currentConnectionOption()
void	deregisterMessageReceiver(NetworkMessageConsumer messageConsumer)
abstract List<CONNOPTION>	getConnectionOptions()
abstract String	getNetworkIdentifier()
abstract boolean	isConnected()
void	registerMessageReceiver(NetworkMessageConsumer messageConsumer)
abstract void	sendMessage(MoppyMessage messageToSend)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Detail

NetworkBridge

public NetworkBridge()

Method Detail

connect

public abstract void connect(CONNOPTION connectionOption)
                      throws IOException

Throws:

IOException

connect

public abstract void connect()
                      throws IOException

Throws:

IOException

isConnected

public abstract boolean isConnected()

sendMessage

public abstract void sendMessage(MoppyMessage messageToSend)
                          throws IOException

Throws:

IOException

getNetworkIdentifier

public abstract String getNetworkIdentifier()

getConnectionOptions

public abstract List<CONNOPTION> getConnectionOptions()

currentConnectionOption

public abstract CONNOPTION currentConnectionOption()

registerMessageReceiver

public void registerMessageReceiver(NetworkMessageConsumer messageConsumer)

deregisterMessageReceiver

public void deregisterMessageReceiver(NetworkMessageConsumer messageConsumer)

acceptNetworkMessage

public void acceptNetworkMessage(NetworkReceivedMessage messageReceived)

Called by network leaves to pass messages from the network. Because any class extending NetworkBridge automatically inherits this method as well as the NetworkMessageConsumer interface, messages will pass through bridge classes to the first non-NetworkBridge NetworkMessageConsumer.

Specified by:

acceptNetworkMessage in interface NetworkMessageConsumer