pt.lsts.imc.net

Class IMCProtocol

java.lang.Object

pt.lsts.imc.net.IMCProtocol

All Implemented Interfaces:

IMessageBus, pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage>

public class IMCProtocol
extends java.lang.Object
implements IMessageBus, pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage>

This class implements the IMC protocol allowing sending / receiving messages and also discovery of IMC peers

Author:

zp

Constructor Summary

Constructors

Constructor and Description
IMCProtocol()
IMCProtocol(int bindPort) Create a new IMCProtocol instance and bind it to given local port
IMCProtocol(java.lang.String localName, int localPort)

Method Summary

Modifier and Type	Method and Description
void	addMessageListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> l) Add a global message listener that will be call on ALL incoming messages
void	addMessageListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> l, java.util.Collection<java.lang.String> typesToListen) Add a listener to be called whenever messages of certain types are received
void	addMessageListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> listener, java.lang.String... typesToListen) Add a listener to be called whenever messages of certain types are received
void	addService(java.lang.String service)
void	addSingleShotListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> listener, java.lang.String typeToListen) Add a listener that will be called once and then removed from the list of observers
long	announceAgeMillis(java.lang.String name) Retrieve time elapsed since last announce of given system name
boolean	broadcast(IMCMessage msg) Send a message to all known (via receiced announces) systems.
void	connect(java.lang.String system)
void	disconnect(java.lang.String system)
int	getLocalId()
java.lang.String	getLocalName()
java.lang.String[]	lookupService(java.lang.String serviceName)
static void	main(java.lang.String[] args)
void	onMessage(pt.lsts.neptus.messages.listener.MessageInfo info, IMCMessage msg)
void	register(java.lang.Object consumer) Register a POJO consumer.
void	removeMessageListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> l) Remove a previously added message listener
boolean	sendMessage(java.lang.String sysName, IMCMessage msg) Send message to a remote system, specifying its name.
boolean	sendReliably(java.lang.String sysName, IMCMessage msg, int timeoutMillis) This method tries to send a message to given destination with reliability.
boolean	sendToPeers(IMCMessage msg) Send a message to the peers that this proto should auto-connect to.
void	setAutoConnect(java.lang.String autoConnect)
void	startReplay(java.lang.String dirToReplay, double speed) Replay an LSF log folder
ImcSystemState	state(java.lang.String name) Retrieve the continuously updated state of the given system
void	stop() Stop this IMCProtocol instance (closes all sockets)
void	stopReplay() Stop replaying
java.lang.String[]	systems() Retrieve a list of known system names (from which an announce has been received)
void	unregister(java.lang.Object consumer) Unregister a previously registered POJO consumer.
java.lang.String	waitFor(java.lang.String systemExpr, long timeoutMillis) This method blocks until a system whose name matches a regular expression is found on the network or null if time has expired.

Methods inherited from class java.lang.Object

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

Constructor Detail

IMCProtocol

public IMCProtocol(java.lang.String localName,
                   int localPort)

IMCProtocol

public IMCProtocol(int bindPort)

Create a new IMCProtocol instance and bind it to given local port

Parameters:

bindPort - The port where to bind for listening to incoming messages (also advertised using multicast)

IMCProtocol

public IMCProtocol()

Method Detail

onMessage

public void onMessage(pt.lsts.neptus.messages.listener.MessageInfo info,
                      IMCMessage msg)

Specified by:

onMessage in interface pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage>

connect

public void connect(java.lang.String system)

disconnect

public void disconnect(java.lang.String system)

getLocalName

public final java.lang.String getLocalName()

getLocalId

public int getLocalId()

addService

public void addService(java.lang.String service)

announceAgeMillis

public long announceAgeMillis(java.lang.String name)

Retrieve time elapsed since last announce of given system name

Parameters:

name - The name of the system

Returns:

Time, in milliseconds since last announce has been received from the given system.
In the case the system has not announced itself yet, -1 is returned.

broadcast

public boolean broadcast(IMCMessage msg)

Send a message to all known (via receiced announces) systems.

Parameters:

msg - The message to be sent.

Returns:

true if the message was tentatively sent to at least one system.

sendToPeers

public boolean sendToPeers(IMCMessage msg)

Send a message to the peers that this proto should auto-connect to.

Parameters:

msg - The message to be sent

Returns:

true if the message was tentatively sent to at least one peer.

sendMessage

public boolean sendMessage(java.lang.String sysName,
                           IMCMessage msg)

Send message to a remote system, specifying its name.

Parameters:

sysName - The name of the system where to send the message

msg - The message to be sent to the system

Returns:

true if the message was sent or false if no such system is known yet.

sendReliably

public boolean sendReliably(java.lang.String sysName,
                            IMCMessage msg,
                            int timeoutMillis)
                     throws java.lang.Exception

This method tries to send a message to given destination with reliability. If the message is not acknowledged by the remote host, this method will thrown an Exception.

Parameters:

sysName - The name of the destination of this message

msg - The message to send to the destination

timeoutMillis - Maximum amount of time, in milliseconds to wait for delivery.

Returns:

true on success.

Throws:

java.lang.Exception - In case the destination is not known, is nor currently reachable or there was an error in the communication.

register

public void register(java.lang.Object consumer)

Register a POJO consumer.

Specified by:

register in interface IMessageBus

See Also:

ImcConsumer

unregister

public void unregister(java.lang.Object consumer)

Unregister a previously registered POJO consumer.

Specified by:

unregister in interface IMessageBus

addMessageListener

public void addMessageListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> listener,
                               java.lang.String... typesToListen)

Add a listener to be called whenever messages of certain types are received

Parameters:

listener - The listener to be added

typesToListen - The list of message abbreviated names to be observed by this listener

addMessageListener

public void addMessageListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> l,
                               java.util.Collection<java.lang.String> typesToListen)

Add a listener to be called whenever messages of certain types are received

Parameters:

l - The listener to be added

typesToListen - Collection of abbreviated names to be observed by this listener

removeMessageListener

public void removeMessageListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> l)

Remove a previously added message listener

Parameters:

l - The listener to be removed from the observers

addMessageListener

public void addMessageListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> l)

Add a global message listener that will be call on ALL incoming messages

Parameters:

l - The global listener to be added to the list of observers

addSingleShotListener

public void addSingleShotListener(pt.lsts.neptus.messages.listener.MessageListener<pt.lsts.neptus.messages.listener.MessageInfo,IMCMessage> listener,
                                  java.lang.String typeToListen)

Add a listener that will be called once and then removed from the list of observers

Parameters:

listener - The listener to be added as a single-shot listener

typeToListen - The type of message to be listen to

systems

public java.lang.String[] systems()

Retrieve a list of known system names (from which an announce has been received)

Returns:

list of known system names

lookupService

public java.lang.String[] lookupService(java.lang.String serviceName)

state

public ImcSystemState state(java.lang.String name)

Retrieve the continuously updated state of the given system

Parameters:

name - The system for which to retrieve the state

Returns:

The existing system state or a newly created state (inactive) if that system is not yet known

startReplay

public void startReplay(java.lang.String dirToReplay,
                        double speed)
                 throws java.lang.Exception

Replay an LSF log folder

Parameters:

dirToReplay - The folder where the files Data.lsf and IMC.xml can be found

speed - The time multiplier (1.0 = real time)

Throws:

java.lang.Exception - In the case the folder cannot be read or any other IO errors

stopReplay

public void stopReplay()

Stop replaying

stop

public void stop()

Stop this IMCProtocol instance (closes all sockets)

setAutoConnect

public void setAutoConnect(java.lang.String autoConnect)

Parameters:

autoConnect - the autoConnect to set

waitFor

public java.lang.String waitFor(java.lang.String systemExpr,
                                long timeoutMillis)

This method blocks until a system whose name matches a regular expression is found on the network or null if time has expired.

Parameters:

systemExpr - The regular expression to look for

timeoutMillis - The maximum amount of time to block

Returns:

The name of the system found

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception