|
S-PLUS Connect/Java v1.0 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SplusSession
Primary connection between Java and the S-PLUS engine. All communication with the S-PLUS engine goes through this interface.
Method Summary | |
---|---|
SplusDataResult |
evalDataQuery(String cmd)
Evaluate an S-PLUS expression in the S-PLUS engine and retrieve the result as an SplusDataResult. |
SplusDataResult |
evalDataQuery(String cmd,
boolean pingEngine,
boolean parseTest)
Evaluate an S-PLUS expression in the S-PLUS engine and retrieve the result as an SplusDataResult. |
SplusDataResult |
evalDataQuery(String cmd,
boolean Output,
boolean Result,
boolean Errors,
boolean Warnings,
boolean Expr)
Evaluate an S-PLUS expression in the S-PLUS engine and retrieve the result as an SplusDataResult. |
SplusDataResult |
evalDataQuery(String cmd,
boolean Output,
boolean Result,
boolean Errors,
boolean Warnings,
boolean Expr,
boolean pingEngine,
boolean parseTest)
Evaluate an S-PLUS expression in the S-PLUS engine and retrieve the result as an SplusDataResult. |
SplusDataResult |
evalDataQuery(String cmd,
boolean Output,
boolean Result,
boolean Errors,
boolean Warnings,
boolean Expr,
int timeout)
Evaluate an S-PLUS expression in the S-PLUS engine and retrieve the result as an SplusDataResult. |
SplusDataResult |
evalDataQuery(String cmd,
boolean Output,
boolean Result,
boolean Errors,
boolean Warnings,
boolean Expr,
int timeout,
boolean pingEngine,
boolean parseTest)
Evaluate an S-PLUS expression in the S-PLUS engine and retrieve the result as an SplusDataResult. |
SplusDataResult |
evalDataQuery(String cmd,
int timeout)
Evaluate an S-PLUS expression in the S-PLUS engine and retrieve the result as an SplusDataResult. |
SplusDataResult |
evalDataQuery(String cmd,
int timeout,
boolean pingEngine,
boolean parseTest)
Evaluate an S-PLUS expression in the S-PLUS engine and retrieve the result as an SplusDataResult. |
char[] |
getCertAccess()
Method allowing clients to get the password to a certificate file on the server. |
String |
getCertFilename()
Method allowing clients to get a path to a certificate file on the server. |
ClientUtilities |
getClientUtilities()
Method allowing clients access to a server-side object with methods to evaluate general static fields and methods on the server via reflection. |
FileInputStreamProxy |
getFileInputStream(String filename)
Get a FileInputStream from the server JVM. |
FileOutputStreamProxy |
getFileOutputStream(String filename)
Get a FileOutputStream from the server JVM. |
void |
Interrupt()
Send an interrupt signal (SIGINT) to the S-PLUS engine. |
boolean |
isRemote()
Test whether the session is remote. |
String |
readSplusErr()
Read any pending standard error text from the S-PLUS engine. |
String |
readSplusOut()
Read any pending standard output from the S-PLUS engine. |
void |
sessionExit()
Shut down the session. |
void |
sessionExit(boolean killClient)
Shut down the session. |
void |
setClientObjectFactory(ClientObjectFactory factory)
Set a ClientObjectFactory that the server can use to perform operations in the client JVM. |
void |
startPollOutput(SplusOutputHandler handler)
Register an SplusOutputHandler to be notified when output is available. |
void |
writeSplusData(String str)
Write text to the data channel. |
void |
writeSplusIn(String str)
Write text to the S-PLUS engine's standard input. |
Method Detail |
---|
void setClientObjectFactory(ClientObjectFactory factory) throws RemoteException
RemoteException
void writeSplusIn(String str) throws RemoteException
RemoteException
void writeSplusData(String str) throws RemoteException
RemoteException
String readSplusOut() throws RemoteException
RemoteException
String readSplusErr() throws RemoteException
RemoteException
SplusDataResult evalDataQuery(String cmd) throws RemoteException, SplusEngineBusyException, SplusIncompleteExpressionException
cmd
- Expression to evaluate.
RemoteException
SplusEngineBusyException
SplusIncompleteExpressionException
SplusDataResult evalDataQuery(String cmd, int timeout) throws RemoteException, SplusEngineBusyException, SplusIncompleteExpressionException
cmd
- Expression to evaluate.timeout
- Seconds to wait before generating an Engine Busy error.
RemoteException
SplusEngineBusyException
SplusIncompleteExpressionException
SplusDataResult evalDataQuery(String cmd, boolean pingEngine, boolean parseTest) throws RemoteException, SplusEngineBusyException, SplusIncompleteExpressionException
Additional flags are available to avert the checking for engine availability and command completeness. This is generally unsafe. If, however, one is certain that the command is correct and the engine is not busy with a previous command or with requests from some other thread, it will speed up the method call by about 150 ms.
cmd
- Expression to evaluate.pingEngine
- Perform a check to see if the S-PLUS engine is
responsive.parseTest
- Perform a check to see if the command parses before
attempting to evaluate it.
RemoteException
SplusEngineBusyException
SplusIncompleteExpressionException
SplusDataResult evalDataQuery(String cmd, int timeout, boolean pingEngine, boolean parseTest) throws RemoteException, SplusEngineBusyException, SplusIncompleteExpressionException
Additional flags are available to avert the checking for engine availability and command completeness. This is generally unsafe. If, however, one is certain that the command is correct and the engine is not busy with a previous command or with requests from some other thread, it will speed up the method call by about 150 ms.
cmd
- Expression to evaluate.timeout
- Seconds to wait before generating an Engine Busy error.pingEngine
- Perform a check to see if the S-PLUS engine is
responsive.parseTest
- Perform a check to see if the command parses before
attempting to evaluate it.
RemoteException
SplusEngineBusyException
SplusIncompleteExpressionException
SplusDataResult evalDataQuery(String cmd, boolean Output, boolean Result, boolean Errors, boolean Warnings, boolean Expr) throws RemoteException, SplusEngineBusyException, SplusIncompleteExpressionException
This version of the method has boolean flags to indicate which elements to include in the SplusDataResult. Set specific flags to false to avoid shipping over unnecessary information.
cmd
- Expression to evaluate.Output
- Include output in the SplusDataResult.Result
- Include data in the SplusDataResult.Errors
- Include errors in the SplusDataResult.Warnings
- Include warnings in the SplusDataResult.Expr
- Include the expression (cmd) reformatted to match the
width of the output.
RemoteException
SplusEngineBusyException
SplusIncompleteExpressionException
SplusDataResult evalDataQuery(String cmd, boolean Output, boolean Result, boolean Errors, boolean Warnings, boolean Expr, boolean pingEngine, boolean parseTest) throws RemoteException, SplusEngineBusyException, SplusIncompleteExpressionException
This version of the method has boolean flags to indicate which elements to include in the SplusDataResult. Set specific flags to false to avoid shipping over unnecessary information.
Additional flags are available to defeat the checking for engine availability and command completeness. This is generally unsafe. If, however, one is certain that the command is correct and the engine is not busy with a previous command or with requests from some other thread, it will speed up the method call by about 150 ms.
cmd
- Expression to evaluate.Output
- Include output in the SplusDataResult.Result
- Include data in the SplusDataResult.Errors
- Include errors in the SplusDataResult.Warnings
- Include warnings in the SplusDataResult.Expr
- Include the expression (cmd) reformatted to match the
width of the output.pingEngine
- Perform a check to see if the S-PLUS engine is
responsive.parseTest
- Perform a check to see if the command parses before
attempting to evaluate it.
RemoteException
SplusEngineBusyException
SplusIncompleteExpressionException
SplusDataResult evalDataQuery(String cmd, boolean Output, boolean Result, boolean Errors, boolean Warnings, boolean Expr, int timeout) throws RemoteException, SplusEngineBusyException, SplusIncompleteExpressionException
This version of the method has boolean flags to indicate which elements to include in the SplusDataResult. Set specific flags to false to avoid shipping over unnecessary information.
cmd
- Expression to evaluate.Output
- Include output in the SplusDataResult.Result
- Include data in the SplusDataResult.Errors
- Include errors in the SplusDataResult.Warnings
- Include warnings in the SplusDataResult.Expr
- Include the expression (cmd) reformatted to match the
width of the output.timeout
- Seconds to wait before generating an Engine Busy error.
RemoteException
SplusEngineBusyException
SplusIncompleteExpressionException
SplusDataResult evalDataQuery(String cmd, boolean Output, boolean Result, boolean Errors, boolean Warnings, boolean Expr, int timeout, boolean pingEngine, boolean parseTest) throws RemoteException, SplusEngineBusyException, SplusIncompleteExpressionException
This version of the method has boolean flags to indicate which elements to include in the SplusDataResult. Set specific flags to false to avoid shipping over unnecessary information.
Additional flags are available to defeat the checking for engine availability and command completeness. This is generally unsafe. If, however, one is certain that the command is correct and the engine is not busy with a previous command or with requests from some other thread, it will speed up the method call by about 150 ms.
cmd
- Expression to evaluate.Output
- Include output in the SplusDataResult.Result
- Include data in the SplusDataResult.Errors
- Include errors in the SplusDataResult.Warnings
- Include warnings in the SplusDataResult.Expr
- Include the expression (cmd) reformatted to match the
width of the output.timeout
- Seconds to wait before generating an Engine Busy error.pingEngine
- Perform a check to see if the S-PLUS engine is
responsive.parseTest
- Perform a check to see if the command parses before
attempting to evaluate it.
RemoteException
SplusEngineBusyException
SplusIncompleteExpressionException
void Interrupt() throws RemoteException
RemoteException
FileInputStreamProxy getFileInputStream(String filename) throws FileNotFoundException, RemoteException
FileNotFoundException
RemoteException
FileOutputStreamProxy getFileOutputStream(String filename) throws FileNotFoundException, RemoteException
FileNotFoundException
RemoteException
boolean isRemote() throws RemoteException
RemoteException
void sessionExit() throws RemoteException
RemoteException
void sessionExit(boolean killClient) throws RemoteException
killClient
- true to tell the client to shut itself down.
RemoteException
void startPollOutput(SplusOutputHandler handler) throws RemoteException
RemoteException
String getCertFilename() throws RemoteException
RemoteException
char[] getCertAccess() throws RemoteException
RemoteException
ClientUtilities getClientUtilities() throws RemoteException
RemoteException
|
S-PLUS Connect/Java v1.0 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |