eu.hgross.blaubot.core.acceptor.discovery

Interface IBlaubotBeacon

All Superinterfaces:

IBlaubotConnectionAcceptor

All Known Implementing Classes:

AdminMessageBeacon, BlaubotBeaconMock, BlaubotBluetoothBeacon, BlaubotBonjourBeacon, BlaubotEthernetFixedDeviceSetBeacon, BlaubotEthernetMulticastBeacon, BlaubotNFCBeacon, BlaubotWifiP2PBeacon, GeoLocationBeacon, GeoLocationBeaconAndroid

public interface IBlaubotBeacon
extends IBlaubotConnectionAcceptor

Beacon to expose the blaubot instance's state to other blaubot instances and discovering purposes. Discovers nearby devices and informs registered listeners about events. The discovery can be started and stopped separately by setting setDiscoveryActivated(...) to true. The discovery SHOULD only be active, if the beacon is started. An implementation MUST start it's own accept thread to handle incoming connections to the beacon and inform registered IBlaubotIncomingConnectionListener about this new connections (see IBlaubotConnectionAcceptor).

Method Summary

Modifier and Type	Method and Description
void	onConnectionStateMachineStateChanged(IBlaubotState state) Called when the ConnectionStateMachine's state has changed.
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.

Methods inherited from interface eu.hgross.blaubot.core.acceptor.IBlaubotConnectionAcceptor

getAdapter, getConnectionMetaData, isStarted, setAcceptorListener, setListeningStateListener, startListening, stopListening

Method Detail

setBlaubot

void setBlaubot(Blaubot blaubot)

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

Parameters:

blaubot - the blaubot instance

setBeaconStore

void setBeaconStore(IBlaubotBeaconStore beaconStore)

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 IBlaubotConnectionAcceptor

Parameters:

beaconStore - the beacon store implementation

setDiscoveryEventListener

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.

Parameters:

discoveryEventListener - the listener to be set

onConnectionStateMachineStateChanged

void onConnectionStateMachineStateChanged(IBlaubotState state)

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

Parameters:

state - the new state of the ConnectionStateMachine

setDiscoveryActivated

void setDiscoveryActivated(boolean active)

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

Parameters:

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