eu.hgross.blaubot.ethernet

Class BlaubotEthernetMulticastBeacon

java.lang.Object

eu.hgross.blaubot.ethernet.BlaubotEthernetMulticastBeacon

All Implemented Interfaces:

IBlaubotBeacon, IBlaubotConnectionAcceptor, IEthernetBeacon

public class BlaubotEthernetMulticastBeacon
extends java.lang.Object
implements IBlaubotBeacon, IEthernetBeacon

Beacon for ethernet using broadcasts. It consists of two broadcast specific threads (Broadcaster and BroadcastDiscoverer) and a beacon accept thread. The broadcasts simply shout the current beaconUUID out in the world. If a BroadcastReceiver gets to recongnize the beaconUUID (which must be the same as its own) the device is added to a TimeoutList. While the discovery is activated, a BeaconScanner goes through all devices known as alive and tries to connect to their beacon. On a successful connection the resulting IBlaubotConnection is handed to the registered IBlaubotIncomingConnectionListener. From here the BlaubotBeaconService will handle the beacon conversation via the ExchangeStatesTask (exchanging BeaconMessages).

Constructor Summary

Constructors

Constructor and Description
BlaubotEthernetMulticastBeacon(int beaconPort, int beaconBroadcastPort)

Method Summary

Modifier and Type	Method and Description
java.lang.Thread	getAcceptThread()
IBlaubotAdapter	getAdapter() Get the adapter of which this acceptor is part of.
int	getBeaconPort()
ConnectionMetaDataDTO	getConnectionMetaData() Get the connection meta data needed to connect to this connector This infos can range from mac addresses over ip addresses to port numbers.
boolean	isStarted() Retrieves the started state of this acceptor.
void	onConnectionStateMachineStateChanged(IBlaubotState state) Called when the ConnectionStateMachine's state has changed.
void	setAcceptorListener(IBlaubotIncomingConnectionListener acceptorListener) Sets a listener that receives callbacks whenever a connection was accepted by the acceptor.
void	setBeaconStore(IBlaubotBeaconStore beaconStore) Setter method for the dependency injection of a beacon store.
void	setBlaubot(Blaubot blaubot) Dependency injecton of the blaubot instance the beacon is working for.
void	setDiscoveryActivated(boolean active) Enables and disables the discovery of other (remote) blaubot devices.
void	setDiscoveryEventListener(IBlaubotDiscoveryEventListener discoveryEventListener) Sets the discovery event listener which gets called whenever another remote device's state was discovered by this beacon or the BlaubotBeaconService.
void	setListeningStateListener(IBlaubotListeningStateListener stateListener) Sets a listener that receives callbacks, when the acceptor started accepting connections (is listening).
void	startListening() Starts the connection acceptor.
void	stopListening() Stops a running acceptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlaubotEthernetMulticastBeacon

public BlaubotEthernetMulticastBeacon(int beaconPort,
                                      int beaconBroadcastPort)

Parameters:

beaconPort - the port to accept beacon connections

beaconBroadcastPort - the broadcast port for announcements

Method Detail

getAdapter

public IBlaubotAdapter getAdapter()

Description copied from interface: IBlaubotConnectionAcceptor

Get the adapter of which this acceptor is part of. TODO: beacons really should not have this method!

Specified by:

getAdapter in interface IBlaubotConnectionAcceptor

Returns:

the adapter

startListening

public void startListening()

Description copied from interface: IBlaubotConnectionAcceptor

Starts the connection acceptor. The start method has to be idempotent.

Specified by:

startListening in interface IBlaubotConnectionAcceptor

stopListening

public void stopListening()

Description copied from interface: IBlaubotConnectionAcceptor

Stops a running acceptor. The stop method has to be idempotent.

Specified by:

stopListening in interface IBlaubotConnectionAcceptor

isStarted

public boolean isStarted()

Description copied from interface: IBlaubotConnectionAcceptor

Retrieves the started state of this acceptor.

Specified by:

isStarted in interface IBlaubotConnectionAcceptor

Returns:

true iff the acceptor is started and now or soon ready to accept incoming connections

setListeningStateListener

public void setListeningStateListener(IBlaubotListeningStateListener stateListener)

Description copied from interface: IBlaubotConnectionAcceptor

Sets a listener that receives callbacks, when the acceptor started accepting connections (is listening). That is if a typically (commonly needed) internal accept thread was started or stopped.

Specified by:

setListeningStateListener in interface IBlaubotConnectionAcceptor

Parameters:

stateListener - the listner to set

setAcceptorListener

public void setAcceptorListener(IBlaubotIncomingConnectionListener acceptorListener)

Description copied from interface: IBlaubotConnectionAcceptor

Sets a listener that receives callbacks whenever a connection was accepted by the acceptor.

Specified by:

setAcceptorListener in interface IBlaubotConnectionAcceptor

Parameters:

acceptorListener - the listener to be set

getConnectionMetaData

public ConnectionMetaDataDTO getConnectionMetaData()

Description copied from interface: IBlaubotConnectionAcceptor

Get the connection meta data needed to connect to this connector This infos can range from mac addresses over ip addresses to port numbers.

Specified by:

getConnectionMetaData in interface IBlaubotConnectionAcceptor

Returns:

the connection meta data

setDiscoveryEventListener

public void setDiscoveryEventListener(IBlaubotDiscoveryEventListener discoveryEventListener)

Description copied from interface: IBlaubotBeacon

Sets the discovery event listener which gets called whenever another remote device's state was discovered by this beacon or the BlaubotBeaconService.

Specified by:

setDiscoveryEventListener in interface IBlaubotBeacon

Parameters:

discoveryEventListener - the listener to be set

onConnectionStateMachineStateChanged

public void onConnectionStateMachineStateChanged(IBlaubotState state)

Description copied from interface: IBlaubotBeacon

Called when the ConnectionStateMachine's state has changed. An implementation has to expose this state as soon as possible to compatible beacons.

Specified by:

onConnectionStateMachineStateChanged in interface IBlaubotBeacon

Parameters:

state - the new state of the ConnectionStateMachine

setDiscoveryActivated

public void setDiscoveryActivated(boolean active)

Description copied from interface: IBlaubotBeacon

Enables and disables the discovery of other (remote) blaubot devices.

Specified by:

setDiscoveryActivated in interface IBlaubotBeacon

Parameters:

active - if set to true, the discovery (if running) will be active - inactive otherwise

getAcceptThread

public java.lang.Thread getAcceptThread()

Specified by:

getAcceptThread in interface IEthernetBeacon

getBeaconPort

public int getBeaconPort()

Specified by:

getBeaconPort in interface IEthernetBeacon

setBlaubot

public void setBlaubot(Blaubot blaubot)

Description copied from interface: IBlaubotBeacon

Dependency injecton of the blaubot instance the beacon is working for. It is guaranteed that this is called before any start/stop calls.

Specified by:

setBlaubot in interface IBlaubotBeacon

Parameters:

blaubot - the blaubot instance

setBeaconStore

public void setBeaconStore(IBlaubotBeaconStore beaconStore)

Description copied from interface: IBlaubotBeacon

Setter method for the dependency injection of a beacon store. It is guaranteed to be called before the beacon is started for the first time.

Specified by:

setBeaconStore in interface IBlaubotBeacon

Specified by:

setBeaconStore in interface IBlaubotConnectionAcceptor

Parameters:

beaconStore - the beacon store implementation