eu.hgross.blaubot.util

Class SubscriptionWatcher

java.lang.Object

eu.hgross.blaubot.util.SubscriptionWatcher

All Implemented Interfaces:

ILifecycleListener, IBlaubotAdminMessageListener

public abstract class SubscriptionWatcher
extends java.lang.Object
implements ILifecycleListener, IBlaubotAdminMessageListener

Handles the state of a subscription using an AdminMessageListener and LifecycleListener. Has to be attached to the channelmanager/lifecycle dispatcher before start like this: watcher.registerWithBlaubot(myBlaubot) XOR watcher.registerWithBlaubotServer(myBlaubot) if a subscription was made, onSubscribed(..) is called. if a subscription is no longer valid, onUnsubscribed() is called.

Constructor Summary

Constructors

Constructor and Description
SubscriptionWatcher(short channelId)

Method Summary

Modifier and Type	Method and Description
boolean	isSubscribed()
void	onAdminMessage(AbstractAdminMessage adminMessage) Called when an admin message was received
void	onConnected() Triggered when the Blaubot instance becomes part of a blaubot kingdom.
void	onDeviceJoined(IBlaubotDevice blaubotDevice) Triggered when another Blaubot instance on another IBlaubotDevice joined the network.
void	onDeviceLeft(IBlaubotDevice blaubotDevice) Triggered when an IBlaubotDevice left the blaubot kingdom.
void	onDisconnected() Triggered when the Blaubot instance is no longer part of a blaubot kingdom.
void	onKingDeviceChanged(IBlaubotDevice oldKing, IBlaubotDevice newKing) Triggered when the king device was changed.
void	onPrinceDeviceChanged(IBlaubotDevice oldPrince, IBlaubotDevice newPrince) Triggered when a prince nomination was completed.
abstract void	onSubscribed(short channelId) Called when the subscription was lost due to an unsubscribe or onDisconnected event
abstract void	onUnsubscribed(short channelId) Called when a subscription to the channel was made.
void	registerWithBlaubot(Blaubot blaubot)
void	registerWithBlaubotKingdom(BlaubotKingdom blaubotKingdom)
void	unregisterFromBlaubot(Blaubot blaubot)
void	unregisterFromBlaubotKingdom(BlaubotKingdom blaubotKingdom)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubscriptionWatcher

public SubscriptionWatcher(short channelId)

Method Detail

registerWithBlaubot

public void registerWithBlaubot(Blaubot blaubot)

unregisterFromBlaubot

public void unregisterFromBlaubot(Blaubot blaubot)

registerWithBlaubotKingdom

public void registerWithBlaubotKingdom(BlaubotKingdom blaubotKingdom)

unregisterFromBlaubotKingdom

public void unregisterFromBlaubotKingdom(BlaubotKingdom blaubotKingdom)

onAdminMessage

public void onAdminMessage(AbstractAdminMessage adminMessage)

Description copied from interface: IBlaubotAdminMessageListener

Called when an admin message was received

Specified by:

onAdminMessage in interface IBlaubotAdminMessageListener

Parameters:

adminMessage - the received admin message

onUnsubscribed

public abstract void onUnsubscribed(short channelId)

Called when a subscription to the channel was made.

Parameters:

channelId - the channel id

onSubscribed

public abstract void onSubscribed(short channelId)

Called when the subscription was lost due to an unsubscribe or onDisconnected event

Parameters:

channelId - the channel id

onConnected

public void onConnected()

Description copied from interface: ILifecycleListener

Triggered when the Blaubot instance becomes part of a blaubot kingdom.

Specified by:

onConnected in interface ILifecycleListener

onDisconnected

public void onDisconnected()

Description copied from interface: ILifecycleListener

Triggered when the Blaubot instance is no longer part of a blaubot kingdom.

Specified by:

onDisconnected in interface ILifecycleListener

onDeviceJoined

public void onDeviceJoined(IBlaubotDevice blaubotDevice)

Description copied from interface: ILifecycleListener

Triggered when another Blaubot instance on another IBlaubotDevice joined the network. It is guaranteed that for one specific IBlaubotDevice ILifecycleListener.onDeviceJoined(IBlaubotDevice) is never called twice without a triggered ILifecycleListener.onDeviceLeft(IBlaubotDevice) in between.

Specified by:

onDeviceJoined in interface ILifecycleListener

Parameters:

blaubotDevice - the joined device

onDeviceLeft

public void onDeviceLeft(IBlaubotDevice blaubotDevice)

Description copied from interface: ILifecycleListener

Triggered when an IBlaubotDevice left the blaubot kingdom.

Specified by:

onDeviceLeft in interface ILifecycleListener

Parameters:

blaubotDevice - the device that just left

onPrinceDeviceChanged

public void onPrinceDeviceChanged(IBlaubotDevice oldPrince,
                                  IBlaubotDevice newPrince)

Description copied from interface: ILifecycleListener

Triggered when a prince nomination was completed.

Specified by:

onPrinceDeviceChanged in interface ILifecycleListener

Parameters:

oldPrince - the old prince (may be null, in case no prince was nominated previously)

newPrince - the new prince (may be null, in case there is no device to be prince)

onKingDeviceChanged

public void onKingDeviceChanged(IBlaubotDevice oldKing,
                                IBlaubotDevice newKing)

Description copied from interface: ILifecycleListener

Triggered when the king device was changed. Both params may be null, if there was no king before or is no king now.

Specified by:

onKingDeviceChanged in interface ILifecycleListener

Parameters:

oldKing - the old king

newKing - the new king

isSubscribed

public boolean isSubscribed()

Returns:

true, iff the registered instance is currently subscribed to the channel