pt.up.fe.dceg.neptus.comm.iridium

Class IridiumFacade

java.lang.Object

pt.up.fe.dceg.neptus.comm.iridium.IridiumFacade

All Implemented Interfaces:

IridiumMessageListener, IridiumMessenger, IPeriodicUpdates

public class IridiumFacade
extends java.lang.Object
implements IridiumMessenger, IPeriodicUpdates, IridiumMessageListener

Author:

zp

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	iridiumSystemProvider
protected java.util.HashSet<IridiumMessageListener>	listeners
protected java.util.Vector<IridiumMessenger>	messengers

Method Summary

Modifier and Type	Method and Description
void	addListener(IridiumMessageListener listener) Add listener that will be notified when new messages are received
void	cleanup() Method that is called when messengers are removed
<T> T	getFirstMessengerOfType(java.lang.Class<T> type)
static IridiumFacade	getInstance()
java.lang.String	getIridiumSystemProvider()
java.util.Vector<IridiumMessenger>	getMessengers()
java.lang.String	getName() Retrieve messenger's name
boolean	isAvailable() Is this messenger able to receive / send messages
static void	main(java.lang.String[] args)
void	messageReceived(IridiumMessage msg)
long	millisBetweenUpdates() Use this method to return the desired update interval
java.util.Collection<IridiumMessage>	pollMessages(java.util.Date timeSince) Retrieve any messages that were received since given time
void	removeListener(IridiumMessageListener listener) Remove existing message listener
void	sendMessage(pt.up.fe.dceg.neptus.imc.IMCMessage msg)
void	sendMessage(IridiumMessage msg) Send this message across
void	setIridiumSystemProvider(java.lang.String iridiumSystemProvider)
boolean	update() This method is called periodically (same period as specified by IPeriodicUpdates.millisBetweenUpdates()
void	updateMessengers()

Methods inherited from class java.lang.Object

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

Field Detail

messengers

protected java.util.Vector<IridiumMessenger> messengers

iridiumSystemProvider

protected java.lang.String iridiumSystemProvider

listeners

protected java.util.HashSet<IridiumMessageListener> listeners

Method Detail

addListener

public void addListener(IridiumMessageListener listener)

Description copied from interface: IridiumMessenger

Add listener that will be notified when new messages are received

Specified by:

addListener in interface IridiumMessenger

getFirstMessengerOfType

public <T> T getFirstMessengerOfType(java.lang.Class<T> type)

removeListener

public void removeListener(IridiumMessageListener listener)

Description copied from interface: IridiumMessenger

Remove existing message listener

Specified by:

removeListener in interface IridiumMessenger

millisBetweenUpdates

public long millisBetweenUpdates()

Description copied from interface: IPeriodicUpdates

Use this method to return the desired update interval

Specified by:

millisBetweenUpdates in interface IPeriodicUpdates

Returns:

The desired update interval, in milliseconds

update

public boolean update()

Description copied from interface: IPeriodicUpdates

This method is called periodically (same period as specified by IPeriodicUpdates.millisBetweenUpdates()

Specified by:

update in interface IPeriodicUpdates

Returns:

When not interested in being updated anymore, this method should return false. Return true otherwise.

getInstance

public static IridiumFacade getInstance()

sendMessage

public void sendMessage(IridiumMessage msg)
                 throws java.lang.Exception

Description copied from interface: IridiumMessenger

Send this message across

Specified by:

sendMessage in interface IridiumMessenger

Throws:

java.lang.Exception

sendMessage

public void sendMessage(pt.up.fe.dceg.neptus.imc.IMCMessage msg)
                 throws java.lang.Exception

Throws:

java.lang.Exception

pollMessages

public java.util.Collection<IridiumMessage> pollMessages(java.util.Date timeSince)
                                                  throws java.lang.Exception

Description copied from interface: IridiumMessenger

Retrieve any messages that were received since given time

Specified by:

pollMessages in interface IridiumMessenger

Throws:

java.lang.Exception

messageReceived

public void messageReceived(IridiumMessage msg)

Specified by:

messageReceived in interface IridiumMessageListener

updateMessengers

public void updateMessengers()

getName

public java.lang.String getName()

Description copied from interface: IridiumMessenger

Retrieve messenger's name

Specified by:

getName in interface IridiumMessenger

isAvailable

public boolean isAvailable()

Description copied from interface: IridiumMessenger

Is this messenger able to receive / send messages

Specified by:

isAvailable in interface IridiumMessenger

getIridiumSystemProvider

public java.lang.String getIridiumSystemProvider()

Returns:

the iridiumSystemProvider

setIridiumSystemProvider

public void setIridiumSystemProvider(java.lang.String iridiumSystemProvider)

Parameters:

iridiumSystemProvider - the iridiumSystemProvider to set

getMessengers

public java.util.Vector<IridiumMessenger> getMessengers()

Returns:

the messengers

cleanup

public void cleanup()

Description copied from interface: IridiumMessenger

Method that is called when messengers are removed

Specified by:

cleanup in interface IridiumMessenger

main

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

Throws:

java.lang.Exception