eve.io.block

Class RemoteProxy

java.lang.Object

eve.io.block.RemoteProxy

All Implemented Interfaces:

IRemoteProxyMaker

public class RemoteProxy
extends Object
implements IRemoteProxyMaker

This class, along with RemoteProxyServer, makes it easy to implement remote method calls over a streaming connection. The easiest way to do this is:

• Define an interface that covers all the methods you want to call across the connection.
• Make the connection somehow - either via a Socket or by creating connected Input/Output streams or BlockInput/BlockOutput streams.
• On the client side create a RemoteProxy object, set the connection and then call createProxy() to get an Object that implements the interface and which automatically sends remote calls across the connection.
• On the server side create a RemoteProxyServer object, add the server Object that implements the interface and then start it running with the connection.
• Call close() on the RemoteProxy or RemoteProxyServer to close the connection when done.

These class can handle a single threaded mode of operation, where only a single call can be made at a time (this is the most memory efficient way) or multi threaded where multiple calls can be made simultaneously.

Field Summary

Fields

Modifier and Type	Field and Description
long	callTimeoutInMillis Setup the timeout for calls.
boolean	closeIfTimedOut If this is true then the connection is closed if a timeout should occur.
String	defaultTargetName The default name for the target remote object, which can be null.
Class[]	interfaces This is the set of interfaces each proxy Object will implement.
boolean	multiThreaded By default a single-threaded model is used - which is the most memory efficient implementation.
ClassLoader	proxyClassLoader The ClassLoader to use for proxy creation.

Fields inherited from interface eve.sys.IRemoteProxyMaker

OPTION_CLOSE_ON_TIMEOUT, OPTION_IS_MULTITHREADED

Constructor Summary

Constructors

Constructor and Description
RemoteProxy() After calling this constructor you must set the interfaces member to hold the list of interfaces proxy objects will implement.
RemoteProxy(Class interfaceClass) Create a RemoteProxy to implement a single interface, in single threaded mode with no special ClassLoader.
RemoteProxy(Class[] interfaces, boolean multiThreaded) Create a RemoteProxy and set the interfaces list and multiThreaded option.
RemoteProxy(Class interfaceClass, int iRemoteProxyMakerOptions, ClassLoader proxyClassLoader) Create a RemoteProxy and set the interfaces list to hold a single interface.

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection, after which calls to any proxies created will fail.
Object	createProxy() Create an Object that implements the interfaces by making remote calls to a peer object across the connection specified in setConnection.
Object	createProxy(String targetName) Create an Object that implements the interfaces by making remote calls to a peer object across the connection specified in setConnection.
Object	createTestConnection(Object serverObject) Create a local MemoryStream connection across which remote calls will be made.
static void	createTestStreams(InputStream[] inputs, OutputStream[] outputs) Create input and output streams connected to each other via MemoryStreams.
Handle	getRunningHandle() Get a Handle that can be used to monitor the connection.
long	getTimeOut() Get the timeout for receiving responses from remote calls in milliseconds.
boolean	isOpen() Return if the connection is open.
Handle	makeServerObject(Object serverObject, Object inputChannel, Object outputChannel) Used on the server side to make a connection over the input/output channels such that the specified serverObject acts as a server Object for incoming remote method calls on the inputChannel.
void	setConnection(Object input, Object output) Setup the connection.
void	setConnection(Socket connection) Setup the connection.
void	setTimeOut(long timeoutInMillis) Set the timeout for receiving responses from remote calls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

interfaces

public Class[] interfaces

This is the set of interfaces each proxy Object will implement.

multiThreaded

public boolean multiThreaded

By default a single-threaded model is used - which is the most memory efficient implementation. Setting this to true allows multiple Threads to make calls across the connection.

callTimeoutInMillis

public long callTimeoutInMillis

Setup the timeout for calls. Setting a value of -1 means calls never timeout.

closeIfTimedOut

public boolean closeIfTimedOut

If this is true then the connection is closed if a timeout should occur.

defaultTargetName

public String defaultTargetName

The default name for the target remote object, which can be null.

proxyClassLoader

public ClassLoader proxyClassLoader

The ClassLoader to use for proxy creation. This can be null.

Constructor Detail

RemoteProxy

public RemoteProxy()

After calling this constructor you must set the interfaces member to hold the list of interfaces proxy objects will implement. The proxy connection will be single threaded unless multiThreaded is set to true. Call setConnection() followed by createProxy() to connect to the remote server and to create an Object that you can invoke the interface methods on, which will then cause remote calls to be sent to the remote Object.

RemoteProxy

public RemoteProxy(Class interfaceClass,
                   int iRemoteProxyMakerOptions,
                   ClassLoader proxyClassLoader)

Create a RemoteProxy and set the interfaces list to hold a single interface. The proxy connection will be single threaded unless multiThreaded is set to true. Call setConnection() followed by createProxy() to connect to the remote server and to create an Object that you can invoke the interface methods on, which will then cause remote calls to be sent to the remote Object.

Parameters:

interfaceClass - the interface that proxy objects will implement.

iRemoteProxyMakerOptions - any of the IRemoteProxyMaker.OPTION_XXX

proxyClassLoader - an optional ClassLoader to be used when making the proxy. values ORed together.

RemoteProxy

public RemoteProxy(Class[] interfaces,
                   boolean multiThreaded)

Create a RemoteProxy and set the interfaces list and multiThreaded option. Call setConnection() followed by createProxy() to connect to the remote server and to create an Object that you can invoke the interface methods on, which will then cause remote calls to be sent to the remote Object.

Parameters:

interfaces - the list of interfaces that proxy objects will implement.

multiThreaded - true for multithreaded implementations, false for single threaded.

RemoteProxy

public RemoteProxy(Class interfaceClass)

Create a RemoteProxy to implement a single interface, in single threaded mode with no special ClassLoader.

Parameters:

interfaceClass - the interface the proxy will implement.

Method Detail

getTimeOut

public long getTimeOut()

Description copied from interface: IRemoteProxyMaker

Get the timeout for receiving responses from remote calls in milliseconds.

Specified by:

getTimeOut in interface IRemoteProxyMaker

setTimeOut

public void setTimeOut(long timeoutInMillis)

Description copied from interface: IRemoteProxyMaker

Set the timeout for receiving responses from remote calls.

Specified by:

setTimeOut in interface IRemoteProxyMaker

Parameters:

timeoutInMillis - the maximum time in milliseconds to wait for a response from the remote object.

setConnection

public void setConnection(Object input,
                          Object output)
                   throws IOException

Setup the connection. If you want multiThreaded operation, set it true before calling this. After calling this, use createProxy() to create an Object that implements all the Interfaces in the interfaces array.

Specified by:

setConnection in interface IRemoteProxyMaker

Parameters:

input - - this can be an InputStream, a BlockInputStream or a Socket.

output - - this can be an OutputStream, a BlockOutputStream or a Socket.

Throws:

IOException - on any IO error.

setConnection

public void setConnection(Socket connection)
                   throws IOException

Setup the connection. If you want multiThreaded operation, set it true before calling this. After calling this, use createProxy() to create an Object that implements all the Interfaces in the interfaces array.

Parameters:

connection - - a connected Socket.

Throws:

IOException

isOpen

public boolean isOpen()

Return if the connection is open.

Specified by:

isOpen in interface IRemoteProxyMaker

close

public void close()

Close the connection, after which calls to any proxies created will fail.

Specified by:

close in interface IRemoteProxyMaker

getRunningHandle

public Handle getRunningHandle()

Get a Handle that can be used to monitor the connection. If the Stopped bit is set in the handle, this indicates the connection has closed.

Specified by:

getRunningHandle in interface IRemoteProxyMaker

Returns:

a Handle that can be used to monitor the connection.

createProxy

public Object createProxy(String targetName)

Create an Object that implements the interfaces by making remote calls to a peer object across the connection specified in setConnection.

Parameters:

targetName - the name of the target object, which may be null.

Returns:

an Object that implements the interface list.

createProxy

public Object createProxy()

Create an Object that implements the interfaces by making remote calls to a peer object across the connection specified in setConnection. The default name is used for identifying the remote object the method calls will be invoked on.

Specified by:

createProxy in interface IRemoteProxyMaker

Returns:

an Object that implements the interface list.

createTestConnection

public Object createTestConnection(Object serverObject)
                            throws IOException

Create a local MemoryStream connection across which remote calls will be made. Then setup a RemoteProxyServer which will have the serverObject added as the default target object. Then create and return a proxy that implements this RemoteProxy's interfaces and which will invoke the methods on the serverObject across the MemoryStream connection.

Specified by:

createTestConnection in interface IRemoteProxyMaker

Parameters:

serverObject - the serverObject that will have calls invoked on it over the connection link.

Returns:

a proxy Object which implements the interfaces.

Throws:

IOException - on any IO error, which should be none since a MemoryStream is used.

createTestStreams

public static void createTestStreams(InputStream[] inputs,
                                     OutputStream[] outputs)

Create input and output streams connected to each other via MemoryStreams. This is useful for testing remote calls.

Parameters:

inputs - an array of 2 InputStreams. inputs[0] and outputs[0] should be used by one side of the connection and inputs[1] and outputs[1] should be used on the other side.

outputs - an array of 2 OutputStreams. inputs[0] and outputs[0] should be used by one side of the connection and inputs[1] and outputs[1] should be used on the other side.

makeServerObject

public Handle makeServerObject(Object serverObject,
                               Object inputChannel,
                               Object outputChannel)
                        throws IOException

Used on the server side to make a connection over the input/output channels such that the specified serverObject acts as a server Object for incoming remote method calls on the inputChannel. The connection will be multithreaded only if this RemoteProxy is multithreaded.

This RemoteProxy should have been setup to handle a single interface and the serverObject must implement that interface.

Specified by:

makeServerObject in interface IRemoteProxyMaker

Parameters:

serverObject - the object that implements the interface.

inputChannel - this can be an InputStream, a BlockInputStream or a Socket.

outputChannel - this can be an OutputStream, a BlockOutputStream or a Socket.

Returns:

a Handle that indicates if the connection is still active. You can call stop(int reason) on the Handle to stop and close the connection.

Throws:

IOException - on any IO error.