junctionbox

Class Relay

java.lang.Object

junctionbox.Relay

public class Relay
extends java.lang.Object

The Relay class sends OSC messages to the specified target. Messages are stored and refered to by their address pattern with the ability to add integers, floats, longs, strings and blobs to the specified address pattern. Type tags are automatically created when the message is sent.

Version:

0.98

Author:

Lawrence Fyfe

See Also:

The Open Sound Control 1.0 Specification

Constructor Summary

Constructors

Constructor and Description
Relay(java.lang.String ip, int p) Constructs a new Relay object with the specifed target address and port.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBlob(byte[] b) Adds a blob argument to all messages contained in this Relay.
void	addBlob(java.lang.String message, byte[] b) Adds a blob argument to the specifed OSC message.
void	addFloat(float f) Adds a float argument to all messages contained in this Relay.
void	addFloat(float f, float min, float max) Adds a float argument mapped to the provided value range.
void	addFloat(java.lang.String message, float f) Adds a float argument to the specifed OSC message.
void	addFloat(java.lang.String message, float f, float min, float max) Adds a float argument to the specifed OSC message that is mapped to the provided value range.
void	addInteger(int i) Adds an integer argument to all OSC messages contained in this Relay.
void	addInteger(java.lang.String message, int i) Adds an integer argument to the specifed OSC message.
void	addLong(long l) Adds a long argument to all OSC messges contained in this Relay.
void	addLong(java.lang.String message, long l) Adds a long argument to the specified OSC message.
void	addMessage(java.lang.String a) Adds a message to this Relay.
void	addString(java.lang.String s) Adds a String argument to all messages contained in this Relay.
void	addString(java.lang.String message, java.lang.String s) Adds a String argument to the specifed OSC message.
void	clearMessages() Remove all message associated with this Relay.
boolean	containsMessage(java.lang.String m) Determines whether the specified message is contained in this Relay.
java.lang.String	getIPAddress() Returns the IP address associated with this Relay.
java.lang.String	getLabel() Gets the label for this Relay.
int	getMessageCount() Returns the number of messages associated with this Relay.
java.lang.String[]	getMessages() Returns all messages associated with this Relay as an array of Strings.
int	getPort() Returns the port number associated with this Relay.
void	removeMessage(java.lang.String a) Removes the specified message.
void	replaceMessage(java.lang.String a1, java.lang.String a2) Replaces the specified message with a new message.
void	resetMessage(java.lang.String a) Resets the specified message without removing it.
void	send() Sends all messages associated with this Relay
void	send(java.lang.String message) Sends the specified message.
void	send(java.lang.String[] m) Sends all messages specifed in the array provided as an argument
void	setLabel(java.lang.String l) Sets the label for this Relay.
void	setSocket(java.lang.String ip, int p) Sets the IP address and port number.

Methods inherited from class java.lang.Object

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

Constructor Detail

Relay

public Relay(java.lang.String ip,
     int p)

Constructs a new Relay object with the specifed target address and port. The IP address of the target must be an IPv4 address represented in dot-decimal notation. For example, "127.0.0.1" is a valid target string for sending messages to the loopback network interface.

Parameters:

ip - the IP address of the target

p - the port number of the target

Method Detail

setSocket

public void setSocket(java.lang.String ip,
             int p)

Sets the IP address and port number.

Parameters:

ip - the IP address of the target

p - the port number of the target

getIPAddress

public java.lang.String getIPAddress()

Returns the IP address associated with this Relay.

Returns:

the IP address

getPort

public int getPort()

Returns the port number associated with this Relay.

Returns:

the port number

setLabel

public void setLabel(java.lang.String l)

Sets the label for this Relay.

Parameters:

l - the label String

getLabel

public java.lang.String getLabel()

Gets the label for this Relay.

Returns:

the label String or an empty String if no label is set

getMessages

public java.lang.String[] getMessages()

Returns all messages associated with this Relay as an array of Strings.

Returns:

a String array containing messages

getMessageCount

public int getMessageCount()

Returns the number of messages associated with this Relay.

Returns:

the number of messages

addMessage

public void addMessage(java.lang.String a)

Adds a message to this Relay. A message will be added only if it does not currently exist in this Relay.

Parameters:

a - the message string to add

addInteger

public void addInteger(int i)

Adds an integer argument to all OSC messages contained in this Relay.

Parameters:

i - the integer to add

addInteger

public void addInteger(java.lang.String message,
              int i)

Adds an integer argument to the specifed OSC message.

Parameters:

message - the message that will receive the integer

i - the integer to add

addLong

public void addLong(long l)

Adds a long argument to all OSC messges contained in this Relay.

Parameters:

l - the long to add

addLong

public void addLong(java.lang.String message,
           long l)

Adds a long argument to the specified OSC message.

Parameters:

message -

l - the long to add

addFloat

public void addFloat(float f)

Adds a float argument to all messages contained in this Relay.

Parameters:

f - the float to add

addFloat

public void addFloat(java.lang.String message,
            float f)

Adds a float argument to the specifed OSC message.

Parameters:

message - the message that will receive the float argument

f - the float to add

addFloat

public void addFloat(float f,
            float min,
            float max)

Adds a float argument mapped to the provided value range.

Parameters:

f - the float to add

min - the minimum value for the range

max - the maximum value for the range

addFloat

public void addFloat(java.lang.String message,
            float f,
            float min,
            float max)

Adds a float argument to the specifed OSC message that is mapped to the provided value range.

Parameters:

message - the message that will receive the mapped float argument

f - the float to add

min - the minimum value for the range

max - the maximum value for the range

addString

public void addString(java.lang.String s)

Adds a String argument to all messages contained in this Relay.

Parameters:

s - the string to add

addString

public void addString(java.lang.String message,
             java.lang.String s)

Adds a String argument to the specifed OSC message.

Parameters:

message - the message that will receive the string argument

s - the string to add

addBlob

public void addBlob(byte[] b)

Adds a blob argument to all messages contained in this Relay.

Parameters:

b - the blob to add

addBlob

public void addBlob(java.lang.String message,
           byte[] b)

Adds a blob argument to the specifed OSC message.

Parameters:

message - the message that will receive the blob argument

b - the blob to add

containsMessage

public boolean containsMessage(java.lang.String m)

Determines whether the specified message is contained in this Relay.

Parameters:

m - the specified message

Returns:

true if the message is contained, false otherwise

resetMessage

public void resetMessage(java.lang.String a)

Resets the specified message without removing it. Resetting involves clearing the arguments for the message while leaving it available for adding new arguments.

Parameters:

a - the message to reset

replaceMessage

public void replaceMessage(java.lang.String a1,
                  java.lang.String a2)

Replaces the specified message with a new message.

Parameters:

a1 - the message to be replaced

a2 - the new message

removeMessage

public void removeMessage(java.lang.String a)

Removes the specified message.

Parameters:

a - the message to remove

clearMessages

public void clearMessages()

Remove all message associated with this Relay.

send

public void send()

Sends all messages associated with this Relay

send

public void send(java.lang.String message)

Sends the specified message.

Parameters:

message - the message to send

send

public void send(java.lang.String[] m)

Sends all messages specifed in the array provided as an argument

Parameters:

m - an array of messages to send