1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
|
package org.rosuda.REngine.Rserve;
// JRclient library - client interface to Rserve, see http://www.rosuda.org/Rserve/
// Copyright (C) 2004-21 Simon Urbanek
// --- for licensing information see LICENSE file in the original JRclient distribution ---
import java.util.*;
import java.io.*;
import java.net.*;
import org.rosuda.REngine.*;
import org.rosuda.REngine.Rserve.protocol.*;
/** class providing TCP/IP connection to an Rserve
@version $Id$
*/
public class RConnection extends REngine {
/** last error string */
String lastError=null;
Socket s;
boolean connected=false;
InputStream is;
OutputStream os;
boolean authReq=false;
int authType=AT_plain;
String Key=null;
RTalk rt=null;
REXP capabilities = null;
OOBInterface oob = null;
boolean isOCAP = false;
String host;
int port;
/** This static variable specifies the character set used to encode string for transfer. Under normal circumstances there should be no reason for changing this variable. The default is UTF-8, which makes sure that 7-bit ASCII characters are sent in a backward-compatible fashion. Currently (Rserve 0.1-7) there is no further conversion on Rserve's side, i.e. the strings are passed to R without re-coding. If necessary the setting should be changed <u>before</u> connecting to the Rserve in case later Rserves will provide a possibility of setting the encoding during the handshake. */
public static String transferCharset="UTF-8";
/** authorization type: plain text */
public static final int AT_plain = 0;
/** authorization type: unix crypt */
public static final int AT_crypt = 1;
/** version of the server (as reported in IDstring just after Rsrv) */
protected int rsrvVersion;
/** make a new local connection on default port (6311) */
public RConnection() throws RserveException {
this("127.0.0.1",6311);
}
/** make a new connection to specified host on default port (6311)
@param host host name/IP
*/
public RConnection(String host) throws RserveException {
this(host,6311);
}
/** make a new connection to specified host and given port.
* Make sure you check {@link #isConnected} to ensure the connection was successfully created.
* @param host host name/IP
* @param port TCP port
*/
public RConnection(String host, int port) throws RserveException {
this(host, port, null);
}
/** restore a connection based on a previously detached session
* @param session detached session object */
RConnection(RSession session) throws RserveException {
this(null, 0, session);
}
RConnection(String host, int port, RSession session) throws RserveException {
try {
if (connected) s.close();
s = null;
} catch (Exception e) {
throw new RserveException(this, "Cannot close previous connection: " + e.getMessage(), e);
}
if (session != null) {
host = session.host;
port = session.port;
}
connected = false;
this.host = host;
this.port = port;
try {
Socket ss = new Socket(host,port);
// disable Nagle's algorithm since we really want immediate replies
ss.setTcpNoDelay(true);
initWithSocket(ss, session);
} catch (Exception sce) {
throw new RserveException(this, "Cannot connect: "+sce.getMessage(), sce);
}
}
/** create a connection based on a previously obtained
socket. This constructor allows the use of other communication
protocols than TCP/IP (if a Socket implementation exists) or
tunneling through other protocols that expose socket insteface
(such as SSL).
@param sock connected socket
*/
public RConnection(Socket sock) throws RserveException {
this.host = null;
this.port = 0;
try {
if (connected) s.close();
connected = false;
s = null;
} catch (Exception e) {
throw new RserveException(this, "Cannot close previous connection: " + e.getMessage(), e);
}
initWithSocket(sock, null);
}
/** set OOB callbacks, i.e. an object that will handle OOB_SEND and OOB_MSG packets in OCAP mode
@param callbacks object implementing the OOB interface */
public void setOOB(OOBInterface callbacks) {
oob = callbacks;
}
/** initialization in OCAP mode, assumes all communication variables are setup already, expected to be called
by initWithSocket */
private void initOCAP(Socket sock, byte[] header) throws RserveException {
/* there is no version in OCAP but 103 is assumed since that is
the earliest version that supports OCAPs */
rsrvVersion = 103;
isOCAP = true;
connected = true;
RPacket rp = rt.response(header);
capabilities = parseEvalResponse(rp);
}
private void initWithSocket(Socket sock, RSession session) throws RserveException {
s = sock;
try {
is = s.getInputStream();
os = s.getOutputStream();
} catch (Exception gse) {
throw new RserveException(this, "Cannot get io stream: " + gse.getMessage(), gse);
}
rt = new RTalk(is,os);
if (session==null) {
byte[] IDs=new byte[32];
int n=-1;
try {
n=is.read(IDs);
} catch (Exception sre) {
throw new RserveException(this, "Error while receiving data: "+sre.getMessage(), sre);
}
try {
/* is this OCAP mode ? */
if (n >= 16 &&
IDs[0] == 0x52 && IDs[1] == 0x73 &&
IDs[2] == 0x4f && IDs[3] == 0x43) {
/* it is possible that the buffering doesn't work out
and the first packet is <32 bytes, in which case
we have to re-wrap the array to have the correct length */
if (n < 32) {
byte[] header = new byte[n];
System.arraycopy(IDs, 0, header, 0, n);
IDs = header;
}
initOCAP(sock, IDs);
return;
}
if (n!=32) {
throw new RserveException(this,"Handshake failed: expected 32 bytes header, got "+n);
}
String ids = new String(IDs);
/* regular Rserve mode? */
if (ids.substring(0,4).compareTo("Rsrv")!=0)
throw new RserveException(this, "Handshake failed: Rsrv signature expected, but received \""+ids+"\" instead.");
try {
rsrvVersion=Integer.parseInt(ids.substring(4,8));
} catch (Exception px) {}
// we support (knowingly) up to 103
if (rsrvVersion > 103)
throw new RserveException(this, "Handshake failed: The server uses more recent protocol than this client.");
if (ids.substring(8,12).compareTo("QAP1")!=0)
throw new RserveException(this, "Handshake failed: unupported transfer protocol ("+ids.substring(8,12)+"), I talk only QAP1.");
for (int i=12; i<32; i+=4) {
String attr=ids.substring(i,i+4);
if (attr.compareTo("ARpt")==0) {
if (!authReq) { // this method is only fallback when no other was specified
authReq=true;
authType=AT_plain;
}
}
if (attr.compareTo("ARuc")==0) {
authReq=true;
authType=AT_crypt;
}
if (attr.charAt(0)=='K') {
Key=attr.substring(1,3);
}
}
} catch (RserveException innerX) {
try { s.close(); } catch (Exception ex01) {}; is=null; os=null; s=null;
throw innerX;
}
} else { // we have a session to take care of
try {
os.write(session.key,0,32);
} catch (Exception sre) {
throw new RserveException(this, "Error while sending session key: " + sre.getMessage(), sre);
}
rsrvVersion = session.rsrvVersion;
}
connected=true;
lastError="OK";
}
public void finalize() {
close();
is=null;
os=null;
}
/** get server version as reported during the handshake.
@return server version as integer (Rsrv0100 will return 100) */
public int getServerVersion() {
return rsrvVersion;
}
/** closes current connection */
public boolean close() {
try {
if (s != null) s.close();
connected = false;
return true;
} catch(Exception e) { };
return false;
}
/** Returns capabilities received from the server on connect.
For non-OCAP mode this always returns <code>null</code> */
public REXP capabilities() {
return capabilities;
}
/** Check whether this connection is to Rserve in OCAP mode. Note that <code>callOC</code> is
the only command allowed in OCAP mode.
@return <code>true</code> if this connection is in OCAP mode, <code>false</code> otherwise. */
public boolean isOCAP() {
return isOCAP;
}
/** evaluates the given command, but does not fetch the result (useful for assignment
operations)
@param cmd command/expression string */
public void voidEval(String cmd) throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
RPacket rp=rt.request(RTalk.CMD_voidEval,cmd+"\n");
if (rp!=null && rp.isOk()) return;
throw new RserveException(this,"voidEval failed",rp);
}
/** evaluates the given command, detaches the session (see @link{detach()}) and closes connection while the command is being evaluted (requires Rserve 0.4+).
Note that a session cannot be attached again until the commad was successfully processed. Techincally the session is put into listening mode while the command is being evaluated but accept is called only after the command was evaluated. One commonly used techique to monitor detached working sessions is to use second connection to poll the status (e.g. create a temporary file and return the full path before detaching thus allowing new connections to read it).
@param cmd command/expression string
@return session object that can be use to attach back to the session once the command completed */
public RSession voidEvalDetach(String cmd) throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
RPacket rp=rt.request(RTalk.CMD_detachedVoidEval,cmd+"\n");
if (rp==null || !rp.isOk())
throw new RserveException(this,"detached void eval failed",rp);
RSession s = new RSession(this, rp);
close();
return s;
}
REXP parseEvalResponse(RPacket rp) throws RserveException {
int rxo=0;
byte[] pc=rp.getCont();
if (rsrvVersion>100) { /* since 0101 eval responds correctly by using DT_SEXP type/len header which is 4 bytes long */
rxo=4;
/* we should check parameter type (should be DT_SEXP) and fail if it's not */
if (pc[0]!=RTalk.DT_SEXP && pc[0]!=(RTalk.DT_SEXP|RTalk.DT_LARGE))
throw new RserveException(this,"Error while processing eval output: SEXP (type "+RTalk.DT_SEXP+") expected but found result type "+pc[0]+".");
if (pc[0]==(RTalk.DT_SEXP|RTalk.DT_LARGE))
rxo=8; // large data need skip of 8 bytes
/* warning: we are not checking or using the length - we assume that only the one SEXP is returned. This is true for the current CMD_eval implementation, but may not be in the future. */
}
if (pc.length>rxo) {
try {
REXPFactory rx=new REXPFactory();
rx.parseREXP(pc, rxo);
return rx.getREXP();
} catch (REXPMismatchException me) {
me.printStackTrace();
throw new RserveException(this, "Error when parsing response: " + me.getMessage(), me);
}
}
return null;
}
/** evaluates the given command and retrieves the result
@param cmd command/expression string
@return R-xpression or <code>null</code> if an error occured */
public REXP eval(String cmd) throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
RPacket rp=rt.request(RTalk.CMD_eval,cmd+"\n");
if (rp!=null && rp.isOk())
return parseEvalResponse(rp);
throw new RserveException(this,"eval failed",rp);
}
/** assign a string value to a symbol in R. The symbol is created if it doesn't exist already.
@param sym symbol name. Currently assign uses CMD_setSEXP command of Rserve, i.e. the symbol value is NOT parsed. It is the responsibility of the user to make sure that the symbol name is valid in R (recall the difference between a symbol and an expression!). In fact R will always create the symbol, but it may not be accessible (examples: "bar\nfoo" or "bar$foo").
@param ct contents
*/
public void assign(String sym, String ct) throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
try {
byte[] symn = sym.getBytes(transferCharset);
byte[] ctn = ct.getBytes(transferCharset);
int sl = symn.length + 1;
int cl = ctn.length + 1;
if ((sl & 3) > 0) sl = (sl & 0xfffffc) + 4; // make sure the symbol length is divisible by 4
if ((cl & 3) > 0) cl = (cl & 0xfffffc) + 4; // make sure the content length is divisible by 4
byte[] rq=new byte[sl + 4 + cl + 4];
int ic;
for (ic = 0;ic < symn.length; ic++)
rq[ic + 4] = symn[ic];
while (ic < sl)
{ rq[ic + 4] = 0; ic++; }
for (ic = 0; ic < ctn.length; ic++)
rq[ic + sl + 8] = ctn[ic];
while (ic < cl)
{ rq[ic + sl + 8] = 0; ic++; }
RTalk.setHdr(RTalk.DT_STRING, sl, rq, 0);
RTalk.setHdr(RTalk.DT_STRING, cl, rq, sl + 4);
RPacket rp = rt.request(RTalk.CMD_setSEXP, rq);
if (rp !=null && rp.isOk()) return;
throw new RserveException(this, "assign failed", rp);
} catch(java.io.UnsupportedEncodingException e) {
throw new RserveException(this, "unsupported encoding in assign(String,String)", e);
}
}
public REXP callOCAP(REXP call) throws RserveException {
if (!connected || rt == null)
throw new RserveException(this, "Not connected");
if (!isOCAP)
throw new RserveException(this, "callOCAP is only available in OCAP mode");
RPacket rp = rt.request(RTalk.CMD_OCcall, call);
/* process any OOB messages */
while (rp != null && rp.isOOB()) {
REXP payload = parseEvalResponse(rp);
if ((rp.getCmd() & 0xff000) == RTalk.OOB_SEND) {
if (oob != null)
oob.oobSend(rp.getCmd() & 0xfff, payload);
rp = rt.response();
} else if ((rp.getCmd() & 0xff000) == RTalk.OOB_MSG) {
if (oob == null)
throw new RserveException(this, "OOB_MSG received, but no OOB listener registered", rp);
REXP res = oob.oobMessage(rp.getCmd() & 0xfff, payload);
if (res == null)
throw new RserveException(this, "OOB_MSG callback returned null", rp);
// FIXME: we don't have official documentation for this - what is the
// correct response to OOB_MSG? rserve-js uses cmd | RESP_OK/RESP_ERR
// but that mangles low two bits of the OOB code
// Rserve itself doesn't care so it is technically undefined
// The most senstible thing to do is to just copy the cmd since
// the recieving end knows that this is a msg response
rp = rt.request(rp.getCmd(), res);
} else
throw new RserveException(this, "Unsupported OOB command received", rp);
}
if (rp == null || !rp.isOk())
throw new RserveException(this,"callOCAP failed", rp);
return parseEvalResponse(rp);
}
/** assign a content of a REXP to a symbol in R. The symbol is created if it doesn't exist already.
* @param sym symbol name. Currently assign uses CMD_setSEXP command of Rserve, i.e. the symbol value is NOT parsed. It is the responsibility of the user to make sure that the symbol name is valid in R (recall the difference between a symbol and an expression!). In fact R will always create the symbol, but it may not be accessible (examples: "bar\nfoo" or "bar$foo").
* @param rexp contents
*/
public void assign(String sym, REXP rexp) throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
try {
REXPFactory r = new REXPFactory(rexp);
int rl = r.getBinaryLength();
byte[] symn = sym.getBytes(transferCharset);
int sl = symn.length+1;
if ((sl&3)>0) sl=(sl&0xfffffc)+4; // make sure the symbol length is divisible by 4
byte[] rq=new byte[sl+rl+((rl>0xfffff0)?12:8)];
int ic;
for(ic=0;ic<symn.length;ic++) rq[ic+4]=symn[ic];
while(ic<sl) { rq[ic+4]=0; ic++; }; // pad with 0
RTalk.setHdr(RTalk.DT_STRING,sl,rq,0);
RTalk.setHdr(RTalk.DT_SEXP,rl,rq,sl+4);
r.getBinaryRepresentation(rq,sl+((rl>0xfffff0)?12:8));
RPacket rp=rt.request(RTalk.CMD_setSEXP,rq);
if (rp!=null && rp.isOk()) return;
throw new RserveException(this,"assign failed",rp);
} catch(java.io.UnsupportedEncodingException e) {
throw new RserveException(this, "unsupported encoding in assign(String,REXP)", e);
} catch (REXPMismatchException me) {
throw new RserveException(this, "Error creating binary representation: "+me.getMessage(), me);
}
}
/** open a file on the Rserve for reading
@param fn file name. should not contain any path delimiters, since Rserve may restrict the access to local working directory.
@return input stream to be used for reading. Note that the stream is read-once only, there is no support for seek or rewind. */
public RFileInputStream openFile(String fn) throws IOException {
return new RFileInputStream(rt,fn);
}
/** create a file on the Rserve for writing
@param fn file name. should not contain any path delimiters, since Rserve may restrict the access to local working directory.
@return output stream to be used for writinging. Note that the stream is write-once only, there is no support for seek or rewind. */
public RFileOutputStream createFile(String fn) throws IOException {
return new RFileOutputStream(rt,fn);
}
/** remove a file on the Rserve
@param fn file name. should not contain any path delimiters, since Rserve may restrict the access to local working directory. */
public void removeFile(String fn) throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
RPacket rp=rt.request(RTalk.CMD_removeFile,fn);
if (rp!=null && rp.isOk()) return;
throw new RserveException(this,"removeFile failed",rp);
}
/** shutdown remote Rserve. Note that some Rserves cannot be shut down from the client side. */
public void shutdown() throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
RPacket rp=rt.request(RTalk.CMD_shutdown);
if (rp!=null && rp.isOk()) return;
throw new RserveException(this,"shutdown failed",rp);
}
/** Sets send buffer size of the Rserve (in bytes) for the current connection. All responses send by Rserve are stored in the send buffer before transmitting. This means that any objects you want to get from the Rserve need to fit into that buffer. By default the size of the send buffer is 2MB. If you need to receive larger objects from Rserve, you will need to use this function to enlarge the buffer. In order to save memory, you can also reduce the buffer size once it's not used anymore. Currently the buffer size is only limited by the memory available and/or 1GB (whichever is smaller). Current Rserve implementations won't go below buffer sizes of 32kb though. If the specified buffer size results in 'out of memory' on the server, the corresponding error is sent and the connection is terminated.<br>
<i>Note:</i> This command may go away in future versions of Rserve which will use dynamic send buffer allocation.
@param sbs send buffer size (in bytes) min=32k, max=1GB
*/
public void setSendBufferSize(long sbs) throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
RPacket rp=rt.request(RTalk.CMD_setBufferSize,(int)sbs);
if (rp!=null && rp.isOk()) return;
throw new RserveException(this,"setSendBufferSize failed",rp);
}
/** set string encoding for this session. It is strongly
* recommended to make sure the encoding is always set to UTF-8
* because that is the only encoding supported by this Java
* client. It can be done either by uisng the
* <code>encoding</code> option in the server or by calling
* setStringEncoding("utf8") at the beginning of a session (but
* after login).
@param enc name of the encoding as defined by Rserve - as of
Rserve version 0.5-3 valid values are "utf8", "latin1" and
"native" (case-sensitive)
@since Rserve 0.5-3
*/
public void setStringEncoding(String enc) throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
RPacket rp = rt.request(RTalk.CMD_setEncoding, enc);
if (rp != null && rp.isOk()) return;
throw new RserveException(this,"setStringEncoding failed", rp);
}
/** login using supplied user/pwd. Note that login must be the first
command if used
@param user username
@param pwd password */
public void login(String user, String pwd) throws RserveException {
if (!authReq) return;
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
if (authType==AT_crypt) {
if (Key==null) Key="rs";
RPacket rp=rt.request(RTalk.CMD_login,user+"\n"+jcrypt.crypt(Key,pwd));
if (rp!=null && rp.isOk()) return;
try { s.close(); } catch(Exception e) {};
is=null; os=null; s=null; connected=false;
throw new RserveException(this,"login failed",rp);
}
RPacket rp=rt.request(RTalk.CMD_login,user+"\n"+pwd);
if (rp!=null && rp.isOk()) return;
try {s.close();} catch (Exception e) {};
is=null; os=null; s=null; connected=false;
throw new RserveException(this,"login failed",rp);
}
/** detaches the session and closes the connection (requires Rserve 0.4+). The session can be only resumed by calling @link{RSession.attach} */
public RSession detach() throws RserveException {
if (!connected || rt==null)
throw new RserveException(this,"Not connected");
RPacket rp=rt.request(RTalk.CMD_detachSession);
if (rp==null || !rp.isOk())
throw new RserveException(this,"Cannot detach",rp);
RSession s = new RSession(this, rp);
close();
return s;
}
/** check connection state. Note that currently this state is not checked on-the-spot,
that is if connection went down by an outside event this is not reflected by
the flag
@return <code>true</code> if this connection is alive */
public boolean isConnected() { return connected; }
/** check authentication requirement sent by server
@return <code>true</code> is server requires authentication. In such case first
command after connecting must be {@link #login}. */
public boolean needLogin() { return authReq; }
/** get last error string
@return last error string */
public String getLastError() { return lastError; }
/** evaluates the given command in the master server process asynchronously (control command). Note that control commands are always asynchronous, i.e., the expression is enqueued for evaluation in the master process and the method returns before the expression is evaluated (in non-parallel builds the client has to close the connection before the expression can be evaluated). There is no way to check for errors and control commands should be sent with utmost care as they can abort the server process. The evaluation has no immediate effect on the client session.
* @param cmd command/expression string
* @since Rserve 0.6-0 */
public void serverEval(String cmd) throws RserveException {
if (!connected || rt == null)
throw new RserveException(this, "Not connected");
RPacket rp = rt.request(RTalk.CMD_ctrlEval, cmd+"\n");
if (rp != null && rp.isOk()) return;
throw new RserveException(this,"serverEval failed",rp);
}
/** sources the given file (the path must be local to the server!) in the master server process asynchronously (control command). See {@link #serverEval()} for details on control commands.
* @param serverFile path to a file on the server (it is recommended to always use full paths, because the server process has a different working directory than the client child process!).
* @since Rserve 0.6-0 */
public void serverSource(String serverFile) throws RserveException {
if (!connected || rt == null)
throw new RserveException(this, "Not connected");
RPacket rp = rt.request(RTalk.CMD_ctrlSource, serverFile);
if (rp != null && rp.isOk()) return;
throw new RserveException(this,"serverSource failed",rp);
}
/** attempt to shut down the server process cleanly. Note that there is a fundamental difference between the {@link shutdown()} method and this method: <code>serverShutdown()</code> is a proper control command and thus fully authentication controllable, whereas {@link shutdown()} is a client-side command sent to the client child process and thus relying on the ability of the client to signal the server process which may be disabled. Therefore <code>serverShutdown()</code> is preferred and more reliable for Rserve 0.6-0 and higher.
* @since Rserve 0.6-0 */
public void serverShutdown() throws RserveException {
if (!connected || rt == null)
throw new RserveException(this, "Not connected");
RPacket rp = rt.request(RTalk.CMD_ctrlShutdown);
if (rp != null && rp.isOk()) return;
throw new RserveException(this,"serverShutdown failed",rp);
}
//========= REngine interface API
public REXP parse(String text, boolean resolve) throws REngineException {
throw new REngineException(this, "Rserve doesn't support separate parsing step.");
}
public REXP eval(REXP what, REXP where, boolean resolve) throws REngineException {
if (!connected || rt==null)
throw new RserveException(this, "Not connected");
if (where != null)
throw new REngineException(this, "Rserve doesn't support environments other than .GlobalEnv");
try {
REXPFactory r = new REXPFactory(what);
int rl = r.getBinaryLength();
byte[] rq = new byte[rl + ((rl > 0xfffff0) ? 8 : 4)];
RTalk.setHdr(RTalk.DT_SEXP, rl, rq, 0);
r.getBinaryRepresentation(rq, ((rl > 0xfffff0) ? 8 : 4));
RPacket rp = rt.request(resolve ? RTalk.CMD_eval : RTalk.CMD_voidEval, rq);
if (rp != null && rp.isOk())
return parseEvalResponse(rp);
throw new RserveException(this,"eval failed", rp);
} catch (REXPMismatchException me) {
throw new RserveException(this, "Error creating binary representation: " + me.getMessage(), me);
}
}
public REXP parseAndEval(String text, REXP where, boolean resolve) throws REngineException {
if (where!=null) throw new REngineException(this, "Rserve doesn't support environments other than .GlobalEnv");
try {
return eval(text);
} catch (RserveException re) {
throw new REngineException(this, re.getMessage(), re);
}
}
/** assign into an environment
@param symbol symbol name
@param value value to assign
@param env environment to assign to */
public void assign(String symbol, REXP value, REXP env) throws REngineException {
if (env!=null) throw new REngineException(this, "Rserve doesn't support environments other than .GlobalEnv");
try {
assign(symbol, value);
} catch (RserveException re) {
throw new REngineException(this, re.getMessage(), re);
}
}
/** get a value from an environment
@param symbol symbol name
@param env environment
@param resolve resolve the resulting REXP or just return a reference
@return value */
public REXP get(String symbol, REXP env, boolean resolve) throws REngineException {
if (!resolve) throw new REngineException(this, "Rserve doesn't support references");
try {
return eval(new REXPSymbol(symbol), env, true);
} catch (RserveException re) {
throw new REngineException(this, re.getMessage());
}
}
/** fetch the contents of the given reference. The resulting REXP may never be REXPReference.
@param ref reference to resolve
@return resolved reference */
public REXP resolveReference(REXP ref) throws REngineException {
throw new REngineException(this, "Rserve doesn't support references");
}
public REXP createReference(REXP ref) throws REngineException {
throw new REngineException(this, "Rserve doesn't support references");
}
public void finalizeReference(REXP ref) throws REngineException {
throw new REngineException(this, "Rserve doesn't support references");
}
public REXP getParentEnvironment(REXP env, boolean resolve) throws REngineException {
throw new REngineException(this, "Rserve doesn't support environments other than .GlobalEnv");
}
public REXP newEnvironment(REXP parent, boolean resolve) throws REngineException {
throw new REngineException(this, "Rserve doesn't support environments other than .GlobalEnv");
}
}
|