Constructor Detail

• OSCResponderNode

  public OSCResponderNode(Server s,
                          String cmdName,
                          de.sciss.net.OSCListener action)

  Creates a new responder node to listen for messages coming in from the given server. Filters out messages different from the specified command name. Upon reception, the provided OSCListener is invoked.

  After creating the responder, the add method has to be called separately to actually start the listening process.

  Parameters:

  s - server of incoming messages

  cmdName - name of the OSC command at whose arrival the action is invoked

  action - the action's messageReceived method is called upon message reception. Note that just as specified in the OSCListener interface, the action should not assume to be in any particular thread. The current implementation calls the action in the OSC listening thread, but this is not guaranteed. Calls to Swing components should be deferred appropriately.

  See Also:

  Server, add()

• OSCResponderNode

  public OSCResponderNode(Server s,
                          String cmdName,
                          OSCResponderNode.Action action)

  Creates a new responder node to listen for messages coming in from the given server. Filters out messages different from the specified command name. Upon reception, the provided action is invoked.

  After creating the responder, the add method has to be called separately to actually start the listening process.

  Parameters:

  s - server of incoming messages

  cmdName - name of the OSC command at whose arrival the action is invoked

  action - the action's respond method is called upon message reception. Note that just as specified in the OSCListener interface, the action should not assume to be in any particular thread. The current implementation calls the action in the OSC listening thread, but this is not guaranteed. Calls to Swing components should be deferred appropriately.

  See Also:

  Server, add()

Method Detail

• getCommandName

  public String getCommandName()

  Queries the name which is used as the message filter

  Returns:

  the name of the OSC command to which this responder listens

• add

  public OSCResponderNode add()
                       throws IOException

  Adds the node to the list of actively listening nodes. If you are uncertain about the node's state, check isListening first, since this method will throw an IllegalStateException if you try to add it twice.

  Returns:

  the responder node (for convenience)

  Throws:

  IllegalStateException - if the node has already been added

  IOException

  See Also:

  remove(), isListening()

• isListening

  public boolean isListening()

  Queries the node's state.

  Returns:

  true if the node is active (was added), false otherwise (newly created node or removed)

• removeWhenDone

  public OSCResponderNode removeWhenDone()

  Tags the node to remove itself after the next unfiltered message arrived. If the node shall receive exactly one message, a clean code must call this method before calling the add method.

  Returns:

  the responder node (for convenience)

• messageReceived

  public void messageReceived(de.sciss.net.OSCMessage msg,
                              SocketAddress sender,
                              long time)

  This method is called as part of the implementation of the OSCListener interface. It dispatches the message to the action. If removeWhenDone was called, it will remove the node after the action returns.

  Specified by:

  messageReceived in interface de.sciss.net.OSCListener

  See Also:

  removeWhenDone()

• remove

  public OSCResponderNode remove()

  Removes the node from the list of actively listening nodes. If the node was already removed, this method does nothing.

  Returns:

  the responder node (for convenience)

  Throws:

  IOException - if there was a problem

  See Also:

  add()