net.happybrackets.device.network

Class NetworkCommunication

java.lang.Object

net.happybrackets.device.network.NetworkCommunication

public class NetworkCommunication
extends java.lang.Object

This class takes care of communication between the device and the controller. You would mainly use it to send OSC messages to the controller and listen for incoming OSC messages from the controller. However, these methods are both wrapped in the HB class.

Field Summary

Fields

Modifier and Type	Field and Description
FileReceiver	fileReceiver Class for receiving non java files from network

Constructor Summary

Constructors

Constructor and Description
NetworkCommunication(HB _hb) Instantiate a new NetworkCommunication object.

Method Summary

Modifier and Type	Method and Description
void	addListener(de.sciss.net.OSCListener l) Add a @OSCListener that will respond to incoming OSC messages from the controller.
void	clearListeners() Clear all @OSCListeners.
int	getID() Get the ID of this device, as assigned by the controller.
void	removeListener(de.sciss.net.OSCListener l) Remove the given OSCListener.
void	send(de.sciss.net.OSCMessage msg, java.net.InetSocketAddress target) Send a Built OSC Message to server
void	send(java.lang.String msg_name, java.lang.Object[] args) Send an OSC message to the controller.
void	send(java.lang.String msg, java.lang.Object[] args, java.net.InetSocketAddress requester) Send an OSC message to an Address other than the one we have configured as our controller
void	send(java.lang.String msg, java.lang.Object[] args, java.net.SocketAddress requester) Send an OSC message to an Address other than the one we have configured as our controller
void	sendLogs(boolean send_logs) Start or stop sending log messages to the controller.
static boolean	sendNetworkOSCMessages(de.sciss.net.OSCMessage msg, java.util.Collection<java.lang.String> target, boolean skip_self) Send OSC Message across network to one or more targets
boolean	sendTcp(de.sciss.net.OSCMessage msg, java.net.SocketAddress target) Send a Built OSC Message to server

Methods inherited from class java.lang.Object

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

Field Detail

fileReceiver

public FileReceiver fileReceiver

Class for receiving non java files from network

Constructor Detail

NetworkCommunication

public NetworkCommunication(HB _hb)
                     throws java.io.IOException

Instantiate a new NetworkCommunication object.

Parameters:

_hb - the HB object this object is attached to.

Throws:

java.io.IOException - thrown if there is a problem opening the OSCServer, likely due to the port already being in use.

Method Detail

send

public void send(java.lang.String msg_name,
                 java.lang.Object[] args)

Send an OSC message to the controller. This assumes that you have implemented code on the controller side to respond to this message.

Parameters:

msg_name - the message name.

args - the message arguments.

send

public void send(java.lang.String msg,
                 java.lang.Object[] args,
                 java.net.InetSocketAddress requester)

Send an OSC message to an Address other than the one we have configured as our controller

Parameters:

msg - the message name

args - the message arguments

requester - the Address of the device making request

send

public void send(java.lang.String msg,
                 java.lang.Object[] args,
                 java.net.SocketAddress requester)

Send an OSC message to an Address other than the one we have configured as our controller

Parameters:

msg - the message name

args - the message arguments

requester - the Address of the device making request

send

public void send(de.sciss.net.OSCMessage msg,
                 java.net.InetSocketAddress target)

Send a Built OSC Message to server

Parameters:

msg - OSC Message

target - where we need to send message

sendTcp

public boolean sendTcp(de.sciss.net.OSCMessage msg,
                       java.net.SocketAddress target)

Send a Built OSC Message to server

Parameters:

msg - OSC Message

target - where we need to send message

Returns:

true if able to send and no exception thrown

addListener

public void addListener(de.sciss.net.OSCListener l)

Add a @OSCListener that will respond to incoming OSC messages from the controller. Note that this will not listen to broadcast messages from other devices, for which you should use TODO!.

Parameters:

l - the listener.

removeListener

public void removeListener(de.sciss.net.OSCListener l)

Remove the given OSCListener.

Parameters:

l - the listener to remove.

clearListeners

public void clearListeners()

Clear all @OSCListeners.

getID

public int getID()

Get the ID of this device, as assigned by the controller. If the controller has not yet assigned an ID to this device then the ID will be -1. IDs assigned by the controller will be non-negative integers, either from a configuration file of known devices or allocated incrementally upon request.

Returns:

the ID of this device.

sendLogs

public void sendLogs(boolean send_logs)

Start or stop sending log messages to the controller. On the first start the current log file contents will be sent. Upon subsequent starts any new log messages will be sent that were created since the last stop. Until the process is stopped, as new log messages appear they will be sent to the controller.

Parameters:

send_logs - true to start, false to stop.

sendNetworkOSCMessages

public static boolean sendNetworkOSCMessages(de.sciss.net.OSCMessage msg,
                                             java.util.Collection<java.lang.String> target,
                                             boolean skip_self)

Send OSC Message across network to one or more targets

Parameters:

msg - the OSC Message we are sending

target - a list of targets. If null, will broadcast

skip_self - set to true if we are not going to send to ourself

Returns:

true if able to send to at lease one of the addresses