seda.sandStorm.main
Class Sandstorm

java.lang.Object
  extended by seda.sandStorm.main.Sandstorm

public class Sandstorm
extends java.lang.Object

This is the top-level class which acts as the "wrapper" and external interface to the Sandstorm runtime. By creating a Sandstorm object one can embed a Sandstorm system in another application. If you wish to run a standalone Sandstorm, this can be done from the commandline using the seda.sandStorm.main.Main class.

In general it is a good idea to have just one Sandstorm instance per JVM; multiple instances may interfere with one another in terms of resource allocation and thread scheduling.

See Also:
Main, SandstormConfig

Field Summary
private static Sandstorm globalSandstorm
           
private  sandStormMgr mgr
           
 
Constructor Summary
Sandstorm()
          Create a new Sandstorm with the default configuration and no initial stages.
Sandstorm(SandstormConfig config)
          Create a new Sandstorm with the given configuration.
Sandstorm(java.lang.String fname)
          Create a new Sandstorm, reading the configuration from the given file.
 
Method Summary
 ManagerIF getManager()
          Return a handler to the ManagerIF for the Sandstorm instance.
static Sandstorm getSandstorm()
          Returns the currently-running Sandstorm instance, if any.
 SystemManagerIF getSystemManager()
          Return a handle to the SystemManagerIF for the Sandstorm instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mgr

private sandStormMgr mgr

globalSandstorm

private static Sandstorm globalSandstorm
Constructor Detail

Sandstorm

public Sandstorm()
          throws java.lang.Exception
Create a new Sandstorm with the default configuration and no initial stages.

Throws:
java.lang.Exception

Sandstorm

public Sandstorm(java.lang.String fname)
          throws java.lang.Exception
Create a new Sandstorm, reading the configuration from the given file.

Throws:
java.lang.Exception

Sandstorm

public Sandstorm(SandstormConfig config)
          throws java.lang.Exception
Create a new Sandstorm with the given configuration.

Throws:
java.lang.Exception
Method Detail

getManager

public ManagerIF getManager()
Return a handler to the ManagerIF for the Sandstorm instance. This interface allows one to create and obtain handles to stages.


getSystemManager

public SystemManagerIF getSystemManager()
Return a handle to the SystemManagerIF for the Sandstorm instance. This interface allows one to create stages and thread managers.


getSandstorm

public static Sandstorm getSandstorm()
Returns the currently-running Sandstorm instance, if any. Returns null if no Sandstorm is currently running.