eu.hgross.blaubot.android.wifip2p

Class BlaubotWifiP2PBeacon

java.lang.Object

eu.hgross.blaubot.android.wifip2p.BlaubotWifiP2PBeacon

All Implemented Interfaces:

IBlaubotAndroidComponent, IBlaubotBroadcastReceiver, IBlaubotBeacon, IBlaubotConnectionAcceptor, IEthernetBeacon, java.io.Closeable, java.lang.AutoCloseable

public class BlaubotWifiP2PBeacon
extends java.lang.Object
implements IBlaubotBeacon, IBlaubotBroadcastReceiver, IEthernetBeacon, java.io.Closeable, IBlaubotAndroidComponent

We are able to signal some defined strings (see http://upnp.org/specs/dm/UPnP-dm-BasicManagement-v1-Service.pdf) over the upnp framework, so we pick one of them to indicate that there is a blaubot instance running. The beacons then search for this upnp string/service and connect to them to probe if this devices are really blaubot instances. If we find a blaubot instance, they exchange the beaconUUID, and if their beaconIds match the usual BeaconMessage to exchange their states. Sadly we can not communicate additional attributes via upnp service requests (which we should be according to the upnp standard) on android so we have to actively ask for this attributes (beaconId, state) by connecting to the device. see: https://code.google.com/p/android/issues/detail?id=40003

Constructor Summary

Constructors

Constructor and Description
BlaubotWifiP2PBeacon(WifiP2pManager wifiP2pManager, Channel beaconChannel, int beaconPort) The string that we exploit to pre-filter upnp devices before we probe them if they are really a blaubot beacon.

Method Summary

Modifier and Type	Method and Description
void	close()
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.
IntentFilter	getIntentFilter()
BroadcastReceiver	getReceiver()
boolean	isStarted() Retrieves the started state of this acceptor.
void	onConnectionStateMachineStateChanged(IBlaubotState state) Called when the ConnectionStateMachine's state has changed.
void	onNewIntent(Intent intent) Gets called when a new intent was received on the foreground activity
void	onPause(Activity context) Gets called when onPause was called on the foreground activity
void	onResume(Activity context) Gets called when onResume was called on the foreground activity
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	setCurrentContext(Context context) Gets called if the android context changes (onResume).
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

BlaubotWifiP2PBeacon

public BlaubotWifiP2PBeacon(WifiP2pManager wifiP2pManager,
                            Channel beaconChannel,
                            int beaconPort)

The string that we exploit to pre-filter upnp devices before we probe them if they are really a blaubot beacon.

Parameters:

wifiP2pManager - android's wifi p2p manager service

beaconChannel - the wifi p2p channel to be used for this beacon

beaconPort - the tcp port for this beacon to listen on

Method Detail

getAcceptThread

public java.lang.Thread getAcceptThread()

Specified by:

getAcceptThread in interface IEthernetBeacon

getBeaconPort

public int getBeaconPort()

Specified by:

getBeaconPort in interface IEthernetBeacon

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

setCurrentContext

public void setCurrentContext(Context context)

Description copied from interface: IBlaubotAndroidComponent

Gets called if the android context changes (onResume).

Specified by:

setCurrentContext in interface IBlaubotAndroidComponent

Parameters:

context - the context

onResume

public void onResume(Activity context)

Description copied from interface: IBlaubotAndroidComponent

Gets called when onResume was called on the foreground activity

Specified by:

onResume in interface IBlaubotAndroidComponent

Parameters:

context - the foregroudn activity

onPause

public void onPause(Activity context)

Description copied from interface: IBlaubotAndroidComponent

Gets called when onPause was called on the foreground activity

Specified by:

onPause in interface IBlaubotAndroidComponent

Parameters:

context - the current android context

onNewIntent

public void onNewIntent(Intent intent)

Description copied from interface: IBlaubotAndroidComponent

Gets called when a new intent was received on the foreground activity

Specified by:

onNewIntent in interface IBlaubotAndroidComponent

Parameters:

intent - the new intent

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

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

getReceiver

public BroadcastReceiver getReceiver()

Specified by:

getReceiver in interface IBlaubotBroadcastReceiver

Returns:

the receiver that needs to be registered.

getIntentFilter

public IntentFilter getIntentFilter()

Specified by:

getIntentFilter in interface IBlaubotBroadcastReceiver

Returns:

the IntentFilter containing the intents needed by the BroadcastReceiver retrievable via getReceiver()