junctionbox.android

Class Nexus

java.lang.Object

junctionbox.android.Nexus

All Implemented Interfaces:

com.illposed.osc.OSCListener

public class Nexus
extends java.lang.Object
implements com.illposed.osc.OSCListener

The Nexus class implements the NDEF (Nexus Data Exchange Format) specification for managing connections and sharing messages between nodes on a network.

Version:

0.98

Author:

Lawrence Fyfe

See Also:

The Nexus Data Exchange Format Specification

Constructor Summary

Constructors

Constructor and Description
Nexus()

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptMessage(java.util.Date time, com.illposed.osc.OSCMessage message) Accepts certain OSC messages.
void	clearRejectedMessages() Removes all rejected NDEF messages.
java.lang.String	getListeningAddress() Returns the current IP address used to listen for incoming OSC messages.
int	getListeningPort() Returns the current port number used to listen for incoming OSC messages.
java.lang.String	getLocalAddress() Returns the local IP address of the device running this Dispatcher.
java.lang.String[]	getRejectedMessages() Returns any rejected NDEF messages.
Relay	getRelay(int r) Returns the specified Relay.
int	getRelayCount() Returns the number of Relays contained in this Dispatcher.
Relay[]	getRelays() Returns the NDEF message mapping Relays associated with this Dispatcher as an array.
boolean	isConnected(Relay r) Determines whether the specified Relay is connected.
boolean	isConnected(java.lang.String ip, int port) Determines whether the specified combination of IP address and port number is connected.
void	loadXML(java.io.InputStream input) Loads Junction, Relay, and Event data from XML.
void	saveXML(java.io.OutputStream output) Saves Junction, Relay, and Event data to XML.
void	sendConnectionLabel(java.lang.String label) Sends an NDEF connection label command to the default target.
void	sendConnectionLabel(java.lang.String ip, int port, java.lang.String label) Sends an NDEF connection label command to the specified IP address and port.
void	sendConnectionPing() Sends an NDEF connection ping to the default target.
void	sendConnectionPing(java.lang.String ip, int port) Sends an NDEF connection ping to the specified IP address and port.
void	sendConnectionRequest() Sends an NDEF connection request to the IP address and port of the default target node.
void	sendConnectionRequest(java.lang.String label) Sends an NDEF connection request with a label to the IP address and port of the default target node.
void	sendConnectionRequest(java.lang.String ip, int port) Sends an NDEF connection request to the specified IP address and port.
void	sendConnectionRequest(java.lang.String ip, int port, java.lang.String label) Sends an NDEF connection request with a label to the specified IP address and port.
void	sendMessageAdd(java.lang.String m) Sends an add message request to the default target.
void	sendMessageAdd(java.lang.String ip, int port, java.lang.String message) Sends an add message request to the specified target.
void	sendMessageCount() Sends an NDEF message count request to the default target.
void	sendMessageCount(java.lang.String ip, int port) Sends an NDEF message count request to the specified IP address and port.
void	sendMessageRemove(java.lang.String m) Sends a remove message request to the default target.
void	sendMessageRemove(java.lang.String ip, int port, java.lang.String message) Sends a remove message request to the specified target.
void	sendMessageReplace(java.lang.String ip, int port, java.lang.String oldMessage, java.lang.String newMessage) Sends a replace message request to the specified target.
void	sendMessageReplace(java.lang.String oldM, java.lang.String newM) Sends a replace message request to the default target.
void	sendMessageRequest() Sends an NDEF message request to the IP address and port of the default target node.
void	sendMessageRequest(java.lang.String ip, int port) Sends an NDEF message request to the specified IP address and port.
void	startListening(int port) Listen for incoming OSC messages on the given port.
void	startListening(java.lang.String address, int port) Listen for incoming OSC messages on the given socket.
void	stopListening() Stop listening for incoming OSC messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

Nexus

public Nexus()

Method Detail

getLocalAddress

public java.lang.String getLocalAddress()

Returns the local IP address of the device running this Dispatcher.

Returns:

a String representing the IP address or an empty String

startListening

public void startListening(int port)

Listen for incoming OSC messages on the given port. The IP address used will be whatever address is returned by the getLocalAddress() method.

Parameters:

port - the port number

startListening

public void startListening(java.lang.String address,
                  int port)

Listen for incoming OSC messages on the given socket.

Parameters:

address - the IP address

port - the port number

stopListening

public void stopListening()

Stop listening for incoming OSC messages.

getListeningAddress

public java.lang.String getListeningAddress()

Returns the current IP address used to listen for incoming OSC messages.

Returns:

the IP address as a String

getListeningPort

public int getListeningPort()

Returns the current port number used to listen for incoming OSC messages.

Returns:

an int representing the listening port

sendConnectionRequest

public void sendConnectionRequest(java.lang.String ip,
                         int port)

Sends an NDEF connection request to the specified IP address and port.

Parameters:

ip - the IP address

port - the port number

sendConnectionRequest

public void sendConnectionRequest(java.lang.String ip,
                         int port,
                         java.lang.String label)

Sends an NDEF connection request with a label to the specified IP address and port.

Parameters:

ip - the IP address

port - the port number

label - the label

sendConnectionRequest

public void sendConnectionRequest()

Sends an NDEF connection request to the IP address and port of the default target node.

sendConnectionRequest

public void sendConnectionRequest(java.lang.String label)

Sends an NDEF connection request with a label to the IP address and port of the default target node.

Parameters:

label - the label

isConnected

public boolean isConnected(java.lang.String ip,
                  int port)

Determines whether the specified combination of IP address and port number is connected.

Parameters:

ip - the IP address to check

port - the port number to check

Returns:

true if connected, false otherwise

isConnected

public boolean isConnected(Relay r)

Determines whether the specified Relay is connected.

Parameters:

r - the Relay to check

Returns:

true if connected, false otherwise

sendConnectionLabel

public void sendConnectionLabel(java.lang.String ip,
                       int port,
                       java.lang.String label)

Sends an NDEF connection label command to the specified IP address and port.

Parameters:

ip - the IP address

port - the port number

sendConnectionLabel

public void sendConnectionLabel(java.lang.String label)

Sends an NDEF connection label command to the default target.

sendConnectionPing

public void sendConnectionPing(java.lang.String ip,
                      int port)

Sends an NDEF connection ping to the specified IP address and port.

Parameters:

ip - the IP address

port - the port number

sendConnectionPing

public void sendConnectionPing()

Sends an NDEF connection ping to the default target.

sendMessageRequest

public void sendMessageRequest(java.lang.String ip,
                      int port)

Sends an NDEF message request to the specified IP address and port.

Parameters:

ip - the target IP address

port - the target port

sendMessageRequest

public void sendMessageRequest()

Sends an NDEF message request to the IP address and port of the default target node.

sendMessageCount

public void sendMessageCount(java.lang.String ip,
                    int port)

Sends an NDEF message count request to the specified IP address and port.

Parameters:

ip - the IP address

port - the port number

sendMessageCount

public void sendMessageCount()

Sends an NDEF message count request to the default target.

sendMessageAdd

public void sendMessageAdd(java.lang.String ip,
                  int port,
                  java.lang.String message)

Sends an add message request to the specified target.

Parameters:

ip - the target IP address

port - the target port

message - the message to add

sendMessageAdd

public void sendMessageAdd(java.lang.String m)

Sends an add message request to the default target.

Parameters:

m - the message to add

sendMessageRemove

public void sendMessageRemove(java.lang.String ip,
                     int port,
                     java.lang.String message)

Sends a remove message request to the specified target.

Parameters:

ip - the target IP address

port - the target port

message - the message to remove

sendMessageRemove

public void sendMessageRemove(java.lang.String m)

Sends a remove message request to the default target.

Parameters:

m - the message to remove

sendMessageReplace

public void sendMessageReplace(java.lang.String ip,
                      int port,
                      java.lang.String oldMessage,
                      java.lang.String newMessage)

Sends a replace message request to the specified target.

Parameters:

ip - the target IP address

port - the target port

oldMessage - the message to replace

newMessage - the new message

sendMessageReplace

public void sendMessageReplace(java.lang.String oldM,
                      java.lang.String newM)

Sends a replace message request to the default target.

Parameters:

oldM - the message to replace

newM - the new message

acceptMessage

public void acceptMessage(java.util.Date time,
                 com.illposed.osc.OSCMessage message)

Accepts certain OSC messages. Messages currently accepted are Nexus Data Exchange Format (NDEF).

Specified by:

acceptMessage in interface com.illposed.osc.OSCListener

Parameters:

time - the time associated with the message

message - the OSC message

getRelay

public Relay getRelay(int r)

Returns the specified Relay.

Parameters:

r - the index of the Relay

Returns:

the specified Relay

getRelays

public Relay[] getRelays()

Returns the NDEF message mapping Relays associated with this Dispatcher as an array.

Returns:

an array of Relays

getRelayCount

public int getRelayCount()

Returns the number of Relays contained in this Dispatcher.

Returns:

the number of Relays

getRejectedMessages

public java.lang.String[] getRejectedMessages()

Returns any rejected NDEF messages.

Returns:

an array of NDEF message Strings

clearRejectedMessages

public void clearRejectedMessages()

Removes all rejected NDEF messages.

saveXML

public void saveXML(java.io.OutputStream output)

Saves Junction, Relay, and Event data to XML.

Parameters:

output - the file to save to

loadXML

public void loadXML(java.io.InputStream input)

Loads Junction, Relay, and Event data from XML.

Parameters:

input - the file to load from