BroadcastManager (HappyBrackets API)

java.lang.Object
- net.happybrackets.core.BroadcastManager

```
public class BroadcastManager
extends java.lang.Object
```
This class manages broadcast communication - i.e., one to all comms. You would mainly use it to send broadcast messages and listen to broadcast messages. However, these functions are wrapped in the HB class and should be accessed there. Created by ollie on 1/06/2016. Multiple interface behaviour add by Sam Gillespie on 11/08/2016.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BroadcastManager.OnListener` Call back interface for listening to all interfaces where the specific interface matters
`static interface`	`BroadcastManager.OnTransmitter` Call back interface for sending to all interfaces where the specific interface matters

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<BroadcastManager.OnListener>`	`interfaceListeners`
`protected java.util.List<de.sciss.net.OSCListener>`	`listeners`
`protected java.util.List<java.net.NetworkInterface>`	`netInterfaces`
`protected java.util.List<de.sciss.net.OSCListener>`	`peristentListeners`
`protected java.util.List<net.happybrackets.core.BroadcastManager.NetworkInterfacePair<de.sciss.net.OSCReceiver>>`	`receivers`
`protected java.util.List<net.happybrackets.core.BroadcastManager.NetworkInterfacePair<de.sciss.net.OSCTransmitter>>`	`transmitters`

Constructor Summary

Constructors
Constructor and Description

BroadcastManager(java.lang.String address, int port)
Create a new BroadcastManager.

Constructors
Constructor and Description
`BroadcastManager(java.lang.String address, int port)` Create a new BroadcastManager.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBroadcastListener(de.sciss.net.OSCListener bl)` Add a new `OSCListener`.
`void`	`addOnMessage(BroadcastManager.OnListener onListener)` Add a new interface aware listener
`void`	`addPersistentBroadcastListener(de.sciss.net.OSCListener bl)` Add Listeners that do not get cleared when HB is reset
`void`	`broadcast(java.lang.String name, java.lang.Object... args)` Broadcast an `OSCMessage` msg over the multicast group.
`void`	`clearBroadcastListeners()` Clear all `OSCListener`s.
`void`	`dispose()` Calls dispose on all receivers (OSCReceiver) and transmitters (OSCTransmitter).
`void`	`forAllTransmitters(BroadcastManager.OnTransmitter onTransmitter)` Execute onTransmitter.cb(NetworkInterface, OSCTransmitter) for all transmitters.
`static java.net.InetAddress`	`getBroadcast(java.net.NetworkInterface ni)` Get the broadcast address for a particular network interface
`int`	`getPort()` Returns the port we are configured for
`void`	`refreshBroadcaster()` Rebuilds this BroadcastManager.
`void`	`removeBroadcastListener(de.sciss.net.OSCListener bl)` Remove the given `OSCListener`.
`void`	`setDisableSend(boolean disable)` Set to disable sending messages from this broadcaster
`void`	`setThreadSleepTime(int threadSleepTime)` Enable setting of sleep time
`void`	`setWaitForStart(boolean wait)` Cause the BroadcastManager to wait before testing the network ports We need to set this here so we can do it from pluging, otherwise, tests will faile
`java.lang.Thread`	`startRefreshThread()`

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

- Field Detail
  - transmitters
```
protected java.util.List<net.happybrackets.core.BroadcastManager.NetworkInterfacePair<de.sciss.net.OSCTransmitter>> transmitters
```
  - receivers
```
protected java.util.List<net.happybrackets.core.BroadcastManager.NetworkInterfacePair<de.sciss.net.OSCReceiver>> receivers
```
  - listeners
```
protected java.util.List<de.sciss.net.OSCListener> listeners
```
  - peristentListeners
```
protected java.util.List<de.sciss.net.OSCListener> peristentListeners
```
  - interfaceListeners
```
protected java.util.List<BroadcastManager.OnListener> interfaceListeners
```
  - netInterfaces
```
protected java.util.List<java.net.NetworkInterface> netInterfaces
```
- Constructor Detail
  - BroadcastManager
```
public BroadcastManager(java.lang.String address,
                        int port)
```
    Create a new BroadcastManager.
    
    Parameters:
    
    address - should be a multicast address.
    
    port - The port we are sending on
- Method Detail
  - setThreadSleepTime
```
public void setThreadSleepTime(int threadSleepTime)
```
    Enable setting of sleep time
    
    Parameters:
    
    threadSleepTime - the amount of time we want our broadcaster to sleep
  - setDisableSend
```
public void setDisableSend(boolean disable)
```
    Set to disable sending messages from this broadcaster
    
    Parameters:
    
    disable - disable sending
  - setWaitForStart
```
public void setWaitForStart(boolean wait)
```
    Cause the BroadcastManager to wait before testing the network ports We need to set this here so we can do it from pluging, otherwise, tests will faile
    
    Parameters:
    
    wait - set to true if we will wait 5 seconds for a start
  - getPort
```
public int getPort()
```
    Returns the port we are configured for
    
    Returns:
    
    the port configured
  - startRefreshThread
```
public java.lang.Thread startRefreshThread()
```
  - dispose
```
public void dispose()
```
    Calls dispose on all receivers (OSCReceiver) and transmitters (OSCTransmitter).
  - refreshBroadcaster
```
public void refreshBroadcaster()
```
    Rebuilds this BroadcastManager. Effectively deletes this instance and creates a new BroadcastManager.
  - broadcast
```
public void broadcast(java.lang.String name,
                      java.lang.Object... args)
```
    Broadcast an OSCMessage msg over the multicast group.
    
    Parameters:
    
    name - the message string to send.
    
    args - the args to the message.
  - forAllTransmitters
```
public void forAllTransmitters(BroadcastManager.OnTransmitter onTransmitter)
```
    Execute onTransmitter.cb(NetworkInterface, OSCTransmitter) for all transmitters.
    
    Parameters:
    
    onTransmitter - Interface message
  - addPersistentBroadcastListener
```
public void addPersistentBroadcastListener(de.sciss.net.OSCListener bl)
```
    Add Listeners that do not get cleared when HB is reset
    
    Parameters:
    
    bl - The broadcast listener
  - addBroadcastListener
```
public void addBroadcastListener(de.sciss.net.OSCListener bl)
```
    Add a new OSCListener.
    
    Parameters:
    
    bl - the new OSCListener.
  - getBroadcast
```
public static java.net.InetAddress getBroadcast(java.net.NetworkInterface ni)
```
    Get the broadcast address for a particular network interface
    
    Parameters:
    
    ni - Network Intervace. If we set as NULL, we will use 255.255.255.255
    
    Returns:
    
    brodcast address if it exists
  - addOnMessage
```
public void addOnMessage(BroadcastManager.OnListener onListener)
```
    Add a new interface aware listener
    
    Parameters:
    
    onListener - the listener
  - removeBroadcastListener
```
public void removeBroadcastListener(de.sciss.net.OSCListener bl)
```
    Remove the given OSCListener.
    
    Parameters:
    
    bl - the OSCListener to remove.
  - clearBroadcastListeners
```
public void clearBroadcastListeners()
```
    Clear all OSCListeners.

Class BroadcastManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

transmitters

receivers

listeners

peristentListeners

interfaceListeners

netInterfaces

Constructor Detail

BroadcastManager

Method Detail

setThreadSleepTime

setDisableSend

setWaitForStart

getPort

startRefreshThread

dispose

refreshBroadcaster

broadcast

forAllTransmitters

addPersistentBroadcastListener

addBroadcastListener

getBroadcast

addOnMessage

removeBroadcastListener

clearBroadcastListeners