net.fortytwo.smsn.p2p.osc

Class OscControl

java.lang.Object

net.fortytwo.smsn.p2p.osc.OscControl

public abstract class OscControl
extends Object

A controller for a remote device or component, which communicates with it via Open Sound Control (OSC) messages

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	OscControl.DeviceInitializationException

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	logger
protected OscReceiver	receiver
protected long	timeOfLastEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OscControl(OscReceiver receiver)

Method Summary

Modifier and Type	Method and Description
void	connect(OscSender sender) Attaches an OSC sender, also calling the onConnect method which may be used to initialize this control
void	disconnect() Closes and detaches the OSC sender, if one has previously been attached with connect()
OscReceiver	getReceiver() Returns the handler for incoming OSC messages
protected void	onConnect()
void	send(com.illposed.osc.OSCMessage message) Passes an OSC message to the attached sender.
void	setThrottlingPeriod(long throttlingPeriod) Sets the period for synchronous (by default) or asychronous throttling
void	throttleAsynchronously(int bufferCapacity) Start a separate thread to throttle outgoing messages, keeping them in a buffer of limited capacity and dropping messages above that capacity.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

receiver

protected final OscReceiver receiver

timeOfLastEvent

protected long timeOfLastEvent

Constructor Detail

OscControl

protected OscControl(OscReceiver receiver)

Parameters:

receiver - a handler for incoming OSC messages

Method Detail

getReceiver

public OscReceiver getReceiver()

Returns the handler for incoming OSC messages

Returns:

the handler for incoming OSC messages

setThrottlingPeriod

public void setThrottlingPeriod(long throttlingPeriod)

Sets the period for synchronous (by default) or asychronous throttling

Parameters:

throttlingPeriod - a minimum interval between outgoing messages

throttleAsynchronously

public void throttleAsynchronously(int bufferCapacity)

Start a separate thread to throttle outgoing messages, keeping them in a buffer of limited capacity and dropping messages above that capacity. Messages do not follow each other more closely than the given throttling period.

Parameters:

bufferCapacity - the maximum number of messages in a waiting queue of messages to be sent. Additional messages are dropped until the queue shrinks.

connect

public void connect(OscSender sender)

Attaches an OSC sender, also calling the onConnect method which may be used to initialize this control

Parameters:

sender - the new OSC sender

disconnect

public void disconnect()

Closes and detaches the OSC sender, if one has previously been attached with connect()

onConnect

protected void onConnect()

send

public void send(com.illposed.osc.OSCMessage message)

Passes an OSC message to the attached sender. Note: this method is synchronized for the sake of senders of uncertain thread safety

Parameters:

message - the OSC message to send