eu.hgross.blaubot.core.acceptor

Interface IBlaubotConnectionAcceptor

All Known Subinterfaces:

IBlaubotBeacon

All Known Implementing Classes:

AdminMessageBeacon, BlaubotBeaconMock, BlaubotBluetoothBeacon, BlaubotBluetoothConnectionAcceptor, BlaubotBonjourBeacon, BlaubotConnectionAcceptorMock, BlaubotEthernetAcceptor, BlaubotEthernetFixedDeviceSetBeacon, BlaubotEthernetMulticastBeacon, BlaubotJsr82BluetoothAcceptor, BlaubotNFCBeacon, BlaubotWebsocketAcceptor, BlaubotWifiAcceptor, BlaubotWifiP2PAcceptor, BlaubotWifiP2PBeacon, GeoLocationBeacon, GeoLocationBeaconAndroid

public interface IBlaubotConnectionAcceptor

Defines an abstraction for any kind of connection accepting mechanisms. This could be a TCP,UDP, BluetoothSocket ... The state, whether the acceptor is listening for incoming connections or not is populated through events send to the registered IBlaubotListeningStateListener. A connection is successfully established, if the the connection could be accepted and the client send his state but more importantly his connection meta data via a BeaconMessage through the just established connection. The received BeaconMessage MUST then be wrapped in a AbstractBlaubotDiscoveryEvent and be populated to the BeaconStore, in case the just connected client will be pronounced prince and the other peasants have to know the connection meta data. This is crucial because if a client connected to the king without being discovered via a beacon before, the king lacks the connection info which has to be send to his peasants in case he dies. Note that the BeaconMessage already has helper methods to send and receive itself through a IBlaubotConnection and there is not really much to be hand written on that behalf. If a client successfully established a connection it will then be populated through the registered IBlaubotIncomingConnectionListener.

Method Summary

Modifier and Type	Method and Description
IBlaubotAdapter	getAdapter() Get the adapter of which this acceptor is part of.
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	setAcceptorListener(IBlaubotIncomingConnectionListener acceptorListener) Sets a listener that receives callbacks whenever a connection was accepted by the acceptor.
void	setBeaconStore(IBlaubotBeaconStore beaconStore) Dependency injecton for the BeaconStore.
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.

Method Detail

setBeaconStore

void setBeaconStore(IBlaubotBeaconStore beaconStore)

Dependency injecton for the BeaconStore. It is guaranteed that this is set before any call to startListening or stopListening

Parameters:

beaconStore - the beaconStore

getAdapter

IBlaubotAdapter getAdapter()

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

Returns:

the adapter

startListening

void startListening()

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

stopListening

void stopListening()

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

isStarted

boolean isStarted()

Retrieves the started state of this acceptor.

Returns:

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

setListeningStateListener

void setListeningStateListener(IBlaubotListeningStateListener stateListener)

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.

Parameters:

stateListener - the listner to set

setAcceptorListener

void setAcceptorListener(IBlaubotIncomingConnectionListener acceptorListener)

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

Parameters:

acceptorListener - the listener to be set

getConnectionMetaData

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.

Returns:

the connection meta data