core/org.eclipse.statet.rj.server/src/org/eclipse/statet/rj/server/REngine.java

/*=============================================================================#
 # Copyright (c) 2009, 2020 Stephan Wahlbrink and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 # which is available at https://www.apache.org/licenses/LICENSE-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 # 
 # Contributors:
 #     Stephan Wahlbrink <sw@wahlbrink.eu> - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.rj.server;

import java.rmi.Remote;
import java.rmi.RemoteException;
import java.util.Map;


/**
 * Interface to the R console / REPL
 */
public interface REngine extends Remote {
	
	/**
	 * Returns the public server reference
	 * Usually you got this server by the public server reference
	 * 
	 * @return 
	 * @throws RemoteException
	 */
	Server getPublic() throws RemoteException;
	
	/**
	 * Returns a collection of platform data.
	 * Current default items:
	 * <ul>
	 *     <li><code>os.type</code> - {@link String}</li>
	 *     <li><code>file.sep</code> - {@link String}</li>
	 *     <li><code>path.sep</code> - {@link String}</li>
	 *     <li><code>version.string</code> - {@link String}</li>
	 * </ul>
	 * 
	 * @return the map with all available data
	 * @throws RemoteException
	 */
	Map<String, Object> getPlatformData() throws RemoteException;
	
	/**
	 * Sets RJ server properties
	 * 
	 * @param properties map with properties to update
	 * @throws RemoteException
	 */
	void setProperties(Map<String, ? extends Object> properties) throws RemoteException;
	
	/**
	 * Disconnects the client from the server
	 * The client can reconnect using {@link #connect(long)}.
	 * 
	 * @throws RemoteException
	 */
	void disconnect() throws RemoteException;
	
	RjsComObject runMainLoop(RjsComObject com) throws RemoteException;
	RjsComObject runAsync(RjsComObject com) throws RemoteException;
	
	/**
	 * Tests if the connection to R is closed
	 * 
	 * @return <code>true</code> if engine is still valid, otherwise <code>false</code>
	 * @throws RemoteException
	 */
	boolean isClosed() throws RemoteException;
	
}