connections

Class Connections

java.lang.Object

java.util.Observable

connections.Connections

All Implemented Interfaces:

Network<WiredBox>

public class Connections
extends java.util.Observable
implements Network<WiredBox>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Connections.NetWireError
static class	Connections.NetWireException

Method Summary

Methods

Modifier and Type	Method and Description
void	addBox(WiredBox box)
static void	biwire(java.lang.String sourceName, WiredBox source, java.lang.String destinationName, WiredBox destination)
static void	biwire(java.lang.String sourceName, WiredBox source, WiredBox destination)
static void	biwire(WiredBox source, java.lang.String destinationName, WiredBox destination)
static void	biwire(WiredBox source, WiredBox destination)
void	changed()
static void	disconnect(java.lang.String sourceName, WiredBox source, java.lang.String destinationName, WiredBox destination)
static void	disconnect(java.lang.String sourceName, WiredBox source, WiredBox destination)
static void	disconnect(WiredBox source, java.lang.String destinationName, WiredBox destination)
static void	disconnect(WiredBox source, WiredBox destination)
static void	forwardFrom(java.lang.String sourcePortName, WiredBox sourceBox, java.lang.String destinationPortName, WiredBox destinationBox)
static void	forwardFrom(java.lang.String portName, WiredBox sourceBox, WiredBox destinationBox)
static void	forwardFrom(WiredBox sourceBox, WiredBox destinationBox)
static void	forwardTo(java.lang.String sourcePortName, WiredBox sourceBox, java.lang.String destinationPortName, WiredBox destinationBox)
static void	forwardTo(java.lang.String portName, WiredBox sourceBox, WiredBox destinationBox)
static void	forwardTo(WiredBox sourceBox, WiredBox destinationBox)
java.util.ArrayList<WiredBox>	getBoxes()
static Connections	getInstance()
static int	getPortCount()
static Ports	getPorts(WiredBox box)
java.util.IdentityHashMap<WiredBox,Ports>	getPortsHashMap()
java.util.ArrayList<WiredBox>	getTargets(WiredBox box)
static boolean	isVerbose()
static void	obliterateNetwork() For use during interactive network building.
static void	publish(WiredBox box, java.lang.String globalUniqueID) Make a WiredBox available to subscribers.
static void	publish(WiredBox box, java.lang.String globalUniqueID, java.lang.String apiLanguage)
static void	setLocalErrorHandler(ErrorHandler e) for debugging, let errors and exceptions thrown by local wired boxes responding to remote requests be handled locally by e.
static void	setVerbose(boolean verbose)
static WiredBox	subscribe(java.lang.String globalUniqueID) Get a wired box corresponding to the GUID provided.
static WiredBox	subscribe(java.lang.String globalUniqueID, double timeout) Get a wired box corresponding to the GUID provided.
static WiredBox	subscribe(java.lang.String globalUniqueID, double timeout, java.lang.String apiLanguage)
static void	useWireServer(java.lang.String serverURL)
static void	useWireServer(java.net.URL serverURL) You must call this before you can call publish or subscribe.
static void	wire(java.lang.String sourceName, WiredBox source, java.lang.String destinationName, WiredBox destination)
static void	wire(java.lang.String sourceName, WiredBox source, WiredBox destination)
static void	wire(WiredBox source, java.lang.String destinationName, WiredBox destination)
static void	wire(WiredBox source, WiredBox destination)

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Method Detail

biwire

public static void biwire(java.lang.String sourceName,
          WiredBox source,
          java.lang.String destinationName,
          WiredBox destination)

wire

public static void wire(java.lang.String sourceName,
        WiredBox source,
        java.lang.String destinationName,
        WiredBox destination)

disconnect

public static void disconnect(java.lang.String sourceName,
              WiredBox source,
              java.lang.String destinationName,
              WiredBox destination)

biwire

public static void biwire(WiredBox source,
          java.lang.String destinationName,
          WiredBox destination)

wire

public static void wire(WiredBox source,
        java.lang.String destinationName,
        WiredBox destination)

disconnect

public static void disconnect(WiredBox source,
              java.lang.String destinationName,
              WiredBox destination)

biwire

public static void biwire(java.lang.String sourceName,
          WiredBox source,
          WiredBox destination)

wire

public static void wire(java.lang.String sourceName,
        WiredBox source,
        WiredBox destination)

disconnect

public static void disconnect(java.lang.String sourceName,
              WiredBox source,
              WiredBox destination)

biwire

public static void biwire(WiredBox source,
          WiredBox destination)

wire

public static void wire(WiredBox source,
        WiredBox destination)

disconnect

public static void disconnect(WiredBox source,
              WiredBox destination)

getPorts

public static Ports getPorts(WiredBox box)

isVerbose

public static boolean isVerbose()

setVerbose

public static void setVerbose(boolean verbose)

getInstance

public static Connections getInstance()

getPortCount

public static int getPortCount()

getBoxes

public java.util.ArrayList<WiredBox> getBoxes()

Specified by:

getBoxes in interface Network<WiredBox>

addBox

public void addBox(WiredBox box)

changed

public void changed()

getPortsHashMap

public java.util.IdentityHashMap<WiredBox,Ports> getPortsHashMap()

getTargets

public java.util.ArrayList<WiredBox> getTargets(WiredBox box)

Specified by:

getTargets in interface Network<WiredBox>

obliterateNetwork

public static void obliterateNetwork()

For use during interactive network building. Completely clears the current network and leaves a blank slate

forwardTo

public static void forwardTo(WiredBox sourceBox,
             WiredBox destinationBox)

forwardTo

public static void forwardTo(java.lang.String portName,
             WiredBox sourceBox,
             WiredBox destinationBox)

forwardTo

public static void forwardTo(java.lang.String sourcePortName,
             WiredBox sourceBox,
             java.lang.String destinationPortName,
             WiredBox destinationBox)

forwardFrom

public static void forwardFrom(WiredBox sourceBox,
               WiredBox destinationBox)

forwardFrom

public static void forwardFrom(java.lang.String portName,
               WiredBox sourceBox,
               WiredBox destinationBox)

forwardFrom

public static void forwardFrom(java.lang.String sourcePortName,
               WiredBox sourceBox,
               java.lang.String destinationPortName,
               WiredBox destinationBox)

useWireServer

public static void useWireServer(java.net.URL serverURL)
                          throws Connections.NetWireException

You must call this before you can call publish or subscribe. Provide the URL of the hub server which mediates all net wires.

Parameters:

serverURL - the address of the hub server which must be running.

Throws:

Connections.NetWireException - if there is an error connecting/negotiating with the server

useWireServer

public static void useWireServer(java.lang.String serverURL)
                          throws Connections.NetWireException

Throws:

Connections.NetWireException

subscribe

public static WiredBox subscribe(java.lang.String globalUniqueID)
                          throws Connections.NetWireException

Get a wired box corresponding to the GUID provided. The wired box must have been published to the server prior to the call to subscribe(...). useWireServer(URL) must have been called prior to the call to subscribe(...).

Parameters:

globalUniqueID - the GUID of the box you want

Returns:

A stub of a remote WiredBox or a local WiredBox. The object returned may be used wherever WiredBoxen are used elsewhere.

Throws:

Connections.NetWireException

subscribe

public static WiredBox subscribe(java.lang.String globalUniqueID,
                 double timeout)
                          throws Connections.NetWireException

Get a wired box corresponding to the GUID provided. useWireServer(URL) must have been called prior to the call to subscribe(...). if the box specified by globalUniqueID is not available, keep trying to subscribe until the timeout expires. if timeout is less than 0, wait indefinitely.

Parameters:

globalUniqueID - the GUID of the box you want

timeout - seconds before aborting with an exception. waits indefinitely if timeout < 0.

Returns:

A stub of a remote WiredBox or a local WiredBox. The object returned may be used wherever WiredBoxen are used elsewhere.

Throws:

Connections.NetWireException

subscribe

public static WiredBox subscribe(java.lang.String globalUniqueID,
                 double timeout,
                 java.lang.String apiLanguage)
                          throws Connections.NetWireException

Throws:

Connections.NetWireException

publish

public static void publish(WiredBox box,
           java.lang.String globalUniqueID)
                    throws Connections.NetWireException

Make a WiredBox available to subscribers. You need to provide a name that uniquely distinguishes the box. useWireServer(URL) must have been called prior to the call to publish(...).

Parameters:

box - a local WiredBox to be published

globalUniqueID - a string that will name the box so that others can connect to it. No other boxes may be published under this name.

Throws:

Connections.NetWireException

publish

public static void publish(WiredBox box,
           java.lang.String globalUniqueID,
           java.lang.String apiLanguage)
                    throws Connections.NetWireException

Throws:

Connections.NetWireException

setLocalErrorHandler

public static void setLocalErrorHandler(ErrorHandler e)

for debugging, let errors and exceptions thrown by local wired boxes responding to remote requests be handled locally by e.

Parameters:

e - See ErrorHandler