eu.hgross.blaubot.core

Class BlaubotKingdom

java.lang.Object

eu.hgross.blaubot.core.BlaubotKingdom

public class BlaubotKingdom
extends java.lang.Object

The root object for all BlaubotKingdoms connected to the BlaubotServer. It holds the ChannelManager and all connections to this kingdom in a ConnectionManager.

Constructor Summary

Constructors

Constructor and Description
BlaubotKingdom(IBlaubotDevice ownDevice, IBlaubotDevice kingDevice)

Method Summary

Modifier and Type	Method and Description
void	addDisconnectListener(IBlaubotConnectionListener disconnectListener) Adds a listener that gets invoked, if this kingdom disconnected
void	addLifecycleListener(ILifecycleListener lifecycleListener) Adds a listener to this kingdom's life cycle events
void	disconnectKingdom() Closes all connections and releases resources regarding this kingdom.
boolean	equals(java.lang.Object o)
BlaubotChannelManager	getChannelManager() The channel manage to manage channels.
IBlaubotDevice	getKingDevice() Returns the king device, which is the discriminator for a kingdom.
KingdomCensusLifecycleListener	getKingdomCensusLifecycleListener() A KingdomCensusLifecycleListener keeping track of the connected devices.
IBlaubotDevice	getOwnDevice() our own device
int	hashCode()
protected void	manageConnection(BlaubotKingdomConnection connection) Choses the connection to the kingDevice and starts the kingdom management.
void	removeLifecycleListener(ILifecycleListener lifecycleListener) Removes a listener to this kingdom's life cycle events
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BlaubotKingdom

public BlaubotKingdom(IBlaubotDevice ownDevice,
                      IBlaubotDevice kingDevice)

Parameters:

ownDevice - the own device

kingDevice - the device object for the kingdom's king device

Method Detail

manageConnection

protected void manageConnection(BlaubotKingdomConnection connection)

Choses the connection to the kingDevice and starts the kingdom management.

Parameters:

connection - the king-connection that is to be managed by this kingdom instance

Throws:

java.lang.IllegalStateException - if manageConncetion was called before

addDisconnectListener

public void addDisconnectListener(IBlaubotConnectionListener disconnectListener)

Adds a listener that gets invoked, if this kingdom disconnected

Parameters:

disconnectListener - the listener

disconnectKingdom

public void disconnectKingdom()

Closes all connections and releases resources regarding this kingdom.

addLifecycleListener

public void addLifecycleListener(ILifecycleListener lifecycleListener)

Adds a listener to this kingdom's life cycle events

Parameters:

lifecycleListener - the listener to be added

removeLifecycleListener

public void removeLifecycleListener(ILifecycleListener lifecycleListener)

Removes a listener to this kingdom's life cycle events

Parameters:

lifecycleListener - the listener to be removed

getChannelManager

public BlaubotChannelManager getChannelManager()

The channel manage to manage channels.

Returns:

channel manager

getKingDevice

public IBlaubotDevice getKingDevice()

Returns the king device, which is the discriminator for a kingdom.

Returns:

king device

getOwnDevice

public IBlaubotDevice getOwnDevice()

our own device

Returns:

device

getKingdomCensusLifecycleListener

public KingdomCensusLifecycleListener getKingdomCensusLifecycleListener()

A KingdomCensusLifecycleListener keeping track of the connected devices. You can poll the devices, current prince, ... from here.

Returns:

the census listener

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object