BlaubotChannelManager (Blaubot JavaDoc)

java.lang.Object
- eu.hgross.blaubot.messaging.BlaubotChannelManager

```
public class BlaubotChannelManager
extends java.lang.Object
```
Factory class for the creation of BlaubotChannel instances. Keeps all created instances under control. TODO: more documentation here

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Object subscriptionLock
Synchronizes against subscription updates and initial state transfers

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`subscriptionLock` Synchronizes against subscription updates and initial state transfers

Constructor Summary

Constructors
Constructor and Description

BlaubotChannelManager(java.lang.String ownUniqueDeviceId)

Constructors
Constructor and Description
`BlaubotChannelManager(java.lang.String ownUniqueDeviceId)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()` Activates all MessageManagers and Channels
`void`	`addAdminMessageListener(IBlaubotAdminMessageListener adminMessageListener)` Adds a listener for admin messages.
`void`	`addConnection(IBlaubotConnection connection)` Adds a connection to be managed (receiving and sending)
`void`	`addSubscriptionListener(IBlaubotSubscriptionChangeListener subscriptionChangeListener)` Adds a subscription listener to the manager
`int`	`broadcastAdminMessage(BlaubotMessage adminMessage)` Sends a BlaubotMessage as admin message to the master, from where it is dispatched to all clients (including the master).
`BlaubotChannelManagerInfo`	`createChannelManagerInfo()` Creates an object containing detailed informations about the state of the channel manager.
`IBlaubotChannel`	`createOrGetChannel(short channelId)` Creates a channel, if not already existent.
`void`	`deactivate()` Deactivates all MessageManagers and Channels
`protected java.lang.String`	`getOwnUniqueDeviceId()` The uniqueDevice Id
`protected boolean`	`hasConnections()`
`protected boolean`	`isMaster()`
`int`	`publishChannelMessage(BlaubotMessage channelMessage)` Publishes a message posted to a channel to the master, where it is then dispatched further.
`int`	`publishToAllConnections(BlaubotMessage message)` Note: This is a low level messaging method used for internal messaging and admin messages.
`boolean`	`publishToSingleDevice(BlaubotMessage message, java.lang.String uniqueDeviceId)` Note: This is a low level messaging method used for internal messaging and admin messages.
`void`	`removeAdminMessageListener(IBlaubotAdminMessageListener adminMessageListener)` Removes a listener for admin messages.
`void`	`removeConnection(IBlaubotConnection connection)` Removes a connection from the channel manager so it is not being managed anymore
`void`	`removeSubscriptionListener(IBlaubotSubscriptionChangeListener subscriptionChangeListener)` Removes a subscription listener from the manager
`java.util.List<IBlaubotConnection>`	`reset()` Removes all connections (and deactivates their senders/receivers).
`void`	`setMaster(boolean isMaster)` Sets this ChannelManager to master mode, meaning that this instance is managing all communication traffic or acts in client mode.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - subscriptionLock
```
protected final java.lang.Object subscriptionLock
```
    Synchronizes against subscription updates and initial state transfers
- Constructor Detail
  - BlaubotChannelManager
```
public BlaubotChannelManager(java.lang.String ownUniqueDeviceId)
```
    Parameters:
    
    ownUniqueDeviceId - the own unique device id
- Method Detail
  - createOrGetChannel
```
public IBlaubotChannel createOrGetChannel(short channelId)
```
    Creates a channel, if not already existent. If the channel exists, the channel instance will be returned.
    
    Parameters:
    
    channelId - the channel id to create the channel for
    
    Returns:
    
    channel instance corresponding to the given channelId
    
    Throws:
    
    java.lang.IllegalArgumentException - if the channelId is smaller than 0 or greater than 0xffff
  - setMaster
```
public void setMaster(boolean isMaster)
```
    Sets this ChannelManager to master mode, meaning that this instance is managing all communication traffic or acts in client mode. If the previous state was the same, nothing happens. All the connection managers will be discarded when called, meaning that all connections that are still valid have to be added again.
    
    Parameters:
    
    isMaster - notify if the channel manager is now in master role
  - isMaster
```
protected boolean isMaster()
```
  - addConnection
```
public void addConnection(IBlaubotConnection connection)
```
    Adds a connection to be managed (receiving and sending)
    
    Parameters:
    
    connection - the connection to add
  - removeConnection
```
public void removeConnection(IBlaubotConnection connection)
```
    Removes a connection from the channel manager so it is not being managed anymore
    
    Parameters:
    
    connection - the connection to remove
  - getOwnUniqueDeviceId
```
protected java.lang.String getOwnUniqueDeviceId()
```
    The uniqueDevice Id
    
    Returns:
    
    the unique device id
  - publishToAllConnections
```
public int publishToAllConnections(BlaubotMessage message)
```
    Note: This is a low level messaging method used for internal messaging and admin messages. Sends (queues) the given BlaubotMessage to all connections added via addConnection(..) Obviously this means that if in master mode this method dispatches the message to all connected clients and in client mode to the master.
    
    Parameters:
    
    message - the message that will be published
    
    Returns:
    
    the number of message senders to which the message was committed
  - publishToSingleDevice
```
public boolean publishToSingleDevice(BlaubotMessage message,
                                     java.lang.String uniqueDeviceId)
```
    Note: This is a low level messaging method used for internal messaging and admin messages. Use channels for your messages. Sends (queues) the given BlaubotMessage to be sent to the connection(s) of the device with the given uniqueDeviceId (if any managed connection(s) are from the device with uniqueDeviceId).
    
    Parameters:
    
    message - the message to be sent
    
    uniqueDeviceId - the message recipient
    
    Returns:
    
    true iff at least one message sender for this unqiueDeviceId was found
  - publishChannelMessage
```
public int publishChannelMessage(BlaubotMessage channelMessage)
```
    Publishes a message posted to a channel to the master, where it is then dispatched further. This method is called by the message pickers from the channels and only represents the first hop a message makes.
    
    Parameters:
    
    channelMessage - the message to be published
    
    Returns:
    
    the number of message senders that got our message (sendMessage() calls).
  - broadcastAdminMessage
```
public int broadcastAdminMessage(BlaubotMessage adminMessage)
```
    Sends a BlaubotMessage as admin message to the master, from where it is dispatched to all clients (including the master).
    
    Parameters:
    
    adminMessage - the adminMessage to be broadcasted
    
    Returns:
    
    the number of MessageSenders to which the message was committed
  - hasConnections
```
protected boolean hasConnections()
```
    Returns:
    
    true, iff the channel manager has at least one connection
  - addAdminMessageListener
```
public void addAdminMessageListener(IBlaubotAdminMessageListener adminMessageListener)
```
    Adds a listener for admin messages.
    
    Parameters:
    
    adminMessageListener - the listener to add
  - removeAdminMessageListener
```
public void removeAdminMessageListener(IBlaubotAdminMessageListener adminMessageListener)
```
    Removes a listener for admin messages.
    
    Parameters:
    
    adminMessageListener - the listener to be removed
  - reset
```
public java.util.List<IBlaubotConnection> reset()
```
    Removes all connections (and deactivates their senders/receivers).
    
    Returns:
    
    List of removed connections
  - activate
```
public void activate()
```
    Activates all MessageManagers and Channels
  - deactivate
```
public void deactivate()
```
    Deactivates all MessageManagers and Channels
  - createChannelManagerInfo
```
public BlaubotChannelManagerInfo createChannelManagerInfo()
```
    Creates an object containing detailed informations about the state of the channel manager. Useful for debugging and unit testing.
    
    Returns:
    
    the info object
  - addSubscriptionListener
```
public void addSubscriptionListener(IBlaubotSubscriptionChangeListener subscriptionChangeListener)
```
    Adds a subscription listener to the manager
    
    Parameters:
    
    subscriptionChangeListener - the listener to add
  - removeSubscriptionListener
```
public void removeSubscriptionListener(IBlaubotSubscriptionChangeListener subscriptionChangeListener)
```
    Removes a subscription listener from the manager
    
    Parameters:
    
    subscriptionChangeListener - the listener to remove

Class BlaubotChannelManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

subscriptionLock

Constructor Detail

BlaubotChannelManager

Method Detail

createOrGetChannel

setMaster

isMaster

addConnection

removeConnection

getOwnUniqueDeviceId

publishToAllConnections

publishToSingleDevice

publishChannelMessage

broadcastAdminMessage

hasConnections

addAdminMessageListener

removeAdminMessageListener

reset

activate

deactivate

createChannelManagerInfo

addSubscriptionListener

removeSubscriptionListener