Module org.praxislive.internal.osc

Package org.praxislive.internal.osc

Interface OSCBidi

All Superinterfaces:

OSCChannel

All Known Implementing Classes:

OSCClient, OSCServer

public interface OSCBidi
extends OSCChannel

An interface describing common functionality in bidirectional OSC communicators.

Since:

NetUtil 0.30

Version:

0.32, 02-Mar-07

Author:

Hanns Holger Rutz

Field Summary

Fields inherited from interface org.praxislive.internal.osc.OSCChannel

DEFAULTBUFSIZE, kDumpBoth, kDumpHex, kDumpOff, kDumpText, TCP, UDP

Method Summary

Modifier and Type	Method	Description
void	dumpIncomingOSC(int mode, PrintStream stream)	Changes the way incoming messages are dumped to the console.
void	dumpOutgoingOSC(int mode, PrintStream stream)	Changes the way outgoing messages are dumped to the console.
boolean	isActive()	Checks whether the communicator is active (was started) or not (is stopped).
void	start()	Starts the communicator.
void	stop()	Stops the communicator.

Methods inherited from interface org.praxislive.internal.osc.OSCChannel

dispose, dumpOSC, getBufferSize, getCodec, getLocalAddress, getProtocol, setBufferSize, setCodec

Method Detail

start

void start()
    throws IOException

Starts the communicator.

Throws:

IOException - if a networking error occurs

isActive

boolean isActive()

Checks whether the communicator is active (was started) or not (is stopped).

Returns:

true if the communicator is active, false otherwise

stop

void stop()
   throws IOException

Stops the communicator.

Throws:

IOException - if a networking error occurs

dumpIncomingOSC

void dumpIncomingOSC(int mode,
                     PrintStream stream)

Changes the way incoming messages are dumped to the console. By default incoming messages are not dumped. Incoming messages are those received by the client from the server, before they get delivered to registered OSCListeners.

Parameters:

mode - see dumpOSC( int ) for details

stream - the stream to print on, or null which is shorthand for System.err

See Also:

OSCChannel.dumpOSC( int, PrintStream ), dumpOutgoingOSC( int, PrintStream )

dumpOutgoingOSC

void dumpOutgoingOSC(int mode,
                     PrintStream stream)

Changes the way outgoing messages are dumped to the console. By default outgoing messages are not dumped. Outgoing messages are those send via send.

Parameters:

mode - see dumpOSC( int ) for details

stream - the stream to print on, or null which is shorthand for System.err

See Also:

OSCChannel.dumpOSC( int, PrintStream ), dumpIncomingOSC( int, PrintStream )