solidDB Help : solidDB reference : SolidServerControl class interface
  
SolidServerControl class interface
The complete public interface for the SolidServerControl class is described below.
Details on parameters and corresponding ADMIN COMMANDs are included in the SSC function descriptions in section SSC API reference.
For an example of a Linked Library Access (LLA) program that uses some of the methods in this class, see Linked Library Access Java/JDBC sample.
Return value constants
public final static int SSC_SUCCESS = 0;
public final static int SSC_ERROR = 1;
public final static int SSC_ABORT = 2;
public final static int SSC_FINISHED = 3;
public final static int SSC_CONT = 4;
public final static int SSC_CONNECTIONS_EXIST = 5;
public final static int SSC_UNFINISHED_TASKS = 6;
public final static int SSC_INVALID_HANDLE = 7;
public final static int SSC_INVALID_LICENSE = 8;
public final static int SSC_NODATABASEFILE = 9;
public final static int SSC_SERVER_NOTRUNNING = 10;
public final static int SSC_INFO_SERVER_RUNNING = 11;
public final static int SSC_SERVER_INNETCOPYMODE = 12;
/**
 * Initiates a SolidServerControl class. Output is not directed
 * to anyPrintStream.
 *
 * @return SolidServerControl instance
 */
public static SolidServerControl instance()
    throws SolidServerInitializationError;
/**
 * Initiates a SolidServerControl class. Output is being directed
 * to a PrintStream object given in parameter 'os'.
 *
 * @param os the PrintStream for output
 * @return SolidServerControl instance
 *
 */
public static SolidServerControl instance( PrintStream os )
    throws SolidServerInitializationError;
/**
 * setOutStream method sets the output to the given PrintStream *
 * @param os the PrintStream for output */
public void setOutStream( PrintStream os );
/**
 * getOutStream returns the stream used for output in class
 * SolidServerControl
 *
 * @return returns the outputstream of this object
 */
public PrintStream getOutStream();
/**
 * startDisklessServer starts the Linked Library Access server
 * in a diskless mode
 *
 * @param argv       parameter vector for the accelerator server.
 *
 * @param runflags Options for this parameter are
                    SSC_STATE_OPEN, SSC_STATE_CLOSED, and
                    SSC_DISABLE_NETCOPY.
 *
 * @param lic_file The contents of the license file as a string,
 *                  since the diskless version cannot read the
 *                    information from the disk *
 * @param ini_file  The contents of the solid.ini configuration
 *                  file as a string, because the diskless
 *                  version cannot read the information
 *                   from the disk
 *
 * @return the return value from the server :
 *   SSC_SUCCESS
 *   SSC_ERROR
 *   SSC_INVALID_LICENSE - No license or license file found.
 *   SSC_NODATABASEFILE - No database file found.
*/
public static long startDisklessServer( String[] argv, long runflags, String lic_string, String ini_string )
/**
 * startServer starts the Linked Library Access server
 *
 * @param argv      parameter vector for the LLA server
 *                  Note: You must give the working directory
 *                  containing license file (f.ex. -c\tmp) first,
 *                  in front of other parameters.
 *
 * @param runflags  Options for this parameter are
                    SSC_STATE_OPEN, SSC_STATE_CLOSED, and
                    SSC_DISABLE_NETCOPY.
 *
 * @return the return value from the server:
 *                  SSC_SUCCESS
 *                  SSC_ERROR
 *                  SSC_INVALID_LICENSE - No license or invalid
 *                  license file found.
 *                   SSC_NODATABASEFILE - No database file found.
*/
public long startServer( String[] argv, long runflags );
/**
 * stopServer stops the LLA server
 *
 * @param runflags Runflags for stopping LLA server.
 * See section SSCStopServer for more details.
 *
 * @return the return value from the server
 *                  SSC_SUCCESS if server is stopped.
 *                  SSC_CONNECTIONS_EXIT if there are open
 *                  connections.
 *                  SSC_UNFINISHED_TASKS if there are still tasks
 *                  that are executing.
 *                  SSC_SERVER_NOTRUNNING if the server is not
 *                  running.
*/
public long stopServer( int runflags );
/**
 * returns the state of the server: server is running or not
 *
 * @return SSC_STATE_OPEN if server is up and running */
public int getState();
/**
 * registerThread registers this user thread to Linked Library
 * Access server
 * - deprecated as of V6.5 Fix Pack 1
 *
 *
 * @return              the return value from the server
 * SSC_SUCCESS          Registration succeeded.
 * SSC_ERROR            Registration failed.
 * SSC_INVALID_HANDLE   Invalid local server handle given.
 * SSC_SERVER_NOTRUNNING  Server is not running.
*/
public long registerThread();
/**
* unregisterThread unregisters this user thread from the
* Linked Library Access server - deprecated as of V6.5 Fix Pack 1
*
*
* @return               the return value from the server
* SSC_SUCCESS           Registration succeeded.
* SSC_ERROR             Registration failed.
* SSC_INVALID_HANDLE    Invalid local server handle given.
* SSC_SERVER_NOTRUNNING  Server is not running.
*/
public long unregisterThread();