eu.hgross.blaubot.core

Class Blaubot

java.lang.Object

eu.hgross.blaubot.core.Blaubot

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

BlaubotAndroid

public class Blaubot
extends java.lang.Object
implements java.io.Closeable

The top level Blaubot object. Consists of the BlaubotConnectionManager, ConnectionStateMachine, BlaubotChannelManager and a bunch of IBlaubotAdapters. The BlaubotConnectionManager takes IBlaubotConnections that are established by the IBlaubotAdapter implementations which receive incoming connections (IBlaubotConnectionAcceptor) and create connections (IBlaubotConnector). The ConnectionStateMachine manages the IBlaubotStates by receiving AbstractBlaubotStateMachineEvents created from incoming admin BlaubotMessages (from IBlaubotConnections), AbstractBlaubotDeviceDiscoveryEvent (from IBlaubotBeacons) as well as new or closed connections (via IBlaubotConnectionManagerListeners and their events). Based on the ConnectionStateMachines state changes, the BlaubotChannelManager will be set up to act as a Master or a Slave, reset it's context or stop/start it's services.

USAGE:

To create IBlaubotChannels for communication a user can use the createChannel(short) method. Developers should attach ILifecycleListeners to the Blaubot instance to get high level information events about the currently formed Blaubot network (Joins/Leaves of devices, established or broken networks, ...)

Constructor Summary

Constructors

Constructor and Description
Blaubot(IBlaubotDevice ownDevice, BlaubotUUIDSet uuidSet, java.util.List<IBlaubotAdapter> adapters, java.util.List<IBlaubotBeacon> beacons) Creates a blaubot instance upon the given adapters and beacons.

Method Summary

Modifier and Type	Method and Description
void	addLifecycleListener(ILifecycleListener lifecycleListener) Adds an ILifecycleListener to this Blaubot instance.
void	close()
IBlaubotChannel	createChannel(short channelId) Creates the channel with the given id.
boolean	equals(java.lang.Object obj)
java.util.List<IBlaubotAdapter>	getAdapters()
BlaubotChannelManager	getChannelManager()
BlaubotConnectionManager	getConnectionManager()
ConnectionStateMachine	getConnectionStateMachine()
IBlaubotDevice	getOwnDevice() The device object identifying this blaubot instance.
ServerConnectionManager	getServerConnectionManager() The server connection managing connections to a server that are created from the ServerConnector of this blaubot instance or another blaubot instance from a connected network.
BlaubotServerConnector	getServerConnector() The attached server connector
BlaubotUUIDSet	getUuidSet() The uuid set created upon the app uuid.
int	hashCode()
boolean	isStarted()
void	removeLifecycleListener(ILifecycleListener lifecycleListener) Removes an ILifecycleListener from this Blaubot instance.
void	setServerConnector(BlaubotServerConnector serverConnector) Sets the server connector to be used.
void	startBlaubot() Starts blaubot.
void	stopBlaubot() Stops blaubot
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Blaubot

public Blaubot(IBlaubotDevice ownDevice,
               BlaubotUUIDSet uuidSet,
               java.util.List<IBlaubotAdapter> adapters,
               java.util.List<IBlaubotBeacon> beacons)

Creates a blaubot instance upon the given adapters and beacons.

Parameters:

ownDevice - the own device with the unique device id for this instance

uuidSet - the uuid set containing the beacon and app uuid

adapters - the adapters to be used (currently limited to 1)

beacons - the beacons to be used

Method Detail

setServerConnector

public void setServerConnector(BlaubotServerConnector serverConnector)

Sets the server connector to be used.

Parameters:

serverConnector - the server connector

getServerConnector

public BlaubotServerConnector getServerConnector()

The attached server connector

Returns:

the server connector or null, if setServerConnector was never called.

getOwnDevice

public IBlaubotDevice getOwnDevice()

The device object identifying this blaubot instance.

Returns:

the own blaubot device containing our unique device id.

startBlaubot

public void startBlaubot()

Starts blaubot.

stopBlaubot

public void stopBlaubot()

Stops blaubot

getConnectionManager

public BlaubotConnectionManager getConnectionManager()

getConnectionStateMachine

public ConnectionStateMachine getConnectionStateMachine()

isStarted

public boolean isStarted()

getChannelManager

public BlaubotChannelManager getChannelManager()

getAdapters

public java.util.List<IBlaubotAdapter> getAdapters()

createChannel

public IBlaubotChannel createChannel(short channelId)

Creates the channel with the given id.

Parameters:

channelId - the channel's id

Returns:

a channel object that is usable, when blaubot is connected.

addLifecycleListener

public void addLifecycleListener(ILifecycleListener lifecycleListener)

Adds an ILifecycleListener to this Blaubot instance.

Parameters:

lifecycleListener - the listener to add

removeLifecycleListener

public void removeLifecycleListener(ILifecycleListener lifecycleListener)

Removes an ILifecycleListener from this Blaubot instance.

Parameters:

lifecycleListener - the listener to remove

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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

getUuidSet

public BlaubotUUIDSet getUuidSet()

The uuid set created upon the app uuid.

Returns:

the uuid set

getServerConnectionManager

public ServerConnectionManager getServerConnectionManager()

The server connection managing connections to a server that are created from the ServerConnector of this blaubot instance or another blaubot instance from a connected network.

Returns:

the manager

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object