com.viaoa.remote.multiplexer

Class RemoteMultiplexerClient

java.lang.Object

com.viaoa.remote.multiplexer.RemoteMultiplexerClient

public class RemoteMultiplexerClient
extends Object

Remoting client, that allows a client to access Objects on a server, and call methods on those objects. It allows for any method to have args that are remote objects, which would allow the server to call the client. A method can also return a remote object. Broadcasting is supported, where calling a method on a remote object will be invoked on all other clients and server. This is similar to RMI, except that it allows for many objects (on either server or client) to be remote, uses multiplexer, and less overhead. Example: get a remote object "A" from server call method "a.test(argX)", where arg is a RemoteClass - the server will then be able to call methods on argX. Note: OARemoteThread is used to process requests.

Author:

vvia

Constructor Summary

Constructors

Constructor and Description
RemoteMultiplexerClient(MultiplexerClient multiplexerClient) Creates a new Distributed Client, using the ICEClient multiplexer connection as the transport.

Method Summary

Modifier and Type	Method and Description
protected boolean	_onInvokeForCtoS(RequestInfo ri) Called when a remote/proxy object method is invoked.
protected void	afterInvokeForCtoS(RequestInfo ri) Called after a CtoS remote method is called.
void	afterInvokForStoC(RequestInfo ri) called after a callback method from the server to a local remote object.
void	close()
protected String	createBindName(RequestInfo ri) create a name that will be unique on the server.
protected void	createSocketForStoC() These are vsockets used to listen/wait for method calls from server.
protected void	createSyncRunnableQueueThread()
protected void	finalize()
protected BindInfo	getBindInfo(RequestInfo ri, String name, Object obj, Class interfaceClass, boolean bDontUseQueue)
protected BindInfo	getBindInfo(String name) Find the bind information based on unique name assigned to it.
protected BindInfo	getBindInfo(String name, Object obj, Class interfaceClass, boolean bUsesQueue, boolean bIsBroadcast) Create information that is used to manage a remote object.
protected BindInfo	getBindInfoForObject(Object obj) This is used to be able to find the unique name given to a remote object.
int	getMaximumSocketsForCtoS()
long	getMethodCallCount() number of remote methods called.
int	getMinimumSocketsForCtoS()
MultiplexerClient	getMultiplexerClient()
protected Object	getProxyForBroadcast(String name, Class c, Object callback)
protected Object	getProxyForCtoS(RequestInfo ri, String name, Class c, boolean bDontUseQueue) Create a proxy instance for an Object that is on the server.
protected Object	getProxyForCtoS(String name, Class c, boolean bUsesQueue)
long	getReceivedMethodCount()
Socket	getSocket() Get the real socket.
protected VirtualSocket	getSocketForCtoS()
protected OAPool<VirtualSocket>	getVirtualSocketCtoSPool()
Object	lookup(String lookupName) Get a remote object from the server.
Object	lookupBroadcast(String lookupName, Object callback)
protected Object	onInvokeForCtoS(BindInfo bind, Object proxy, Method method, Object[] args)
protected void	onRemoteThreadCreated(int totalCount, int liveCount)
void	performDGC()
protected void	processMessageForStoC(RequestInfo ri)
protected RemoteObjectInputStream	processStoCSocket(VirtualSocket socket, int threadId, RemoteObjectInputStream ois)
void	registerBroadcast(String lookupName, Object callback) Register a remote object to be called for server broadcasts.
protected void	releaseSocketForCtoS(VirtualSocket vs)
protected void	sendResponseForStoC(RequestInfo ri)
void	setMaximumSocketsForCtoS(int x)
void	setMinimumSocketsForCtoS(int x)
protected void	setupRequestQueueThread() que that has a remoteThread process the request
protected void	setupSyncRequestQueueThread() que that is for sync requests, and sync return values/ack
protected void	setupSyncRunnableQueueThread()

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteMultiplexerClient

public RemoteMultiplexerClient(MultiplexerClient multiplexerClient)

Creates a new Distributed Client, using the ICEClient multiplexer connection as the transport.

Method Detail

getMultiplexerClient

public MultiplexerClient getMultiplexerClient()

close

public void close()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

registerBroadcast

public void registerBroadcast(String lookupName,
                              Object callback)
                       throws Exception

Register a remote object to be called for server broadcasts.

Parameters:

lookupName - name used on server, see: RemoteMultiplexerServer.createClientBroadcast

callback - an impl used when receiving messages from other clients see RemoteMultiplexerServer#createClientBroadcast(String, Class)

Throws:

Exception

lookupBroadcast

public Object lookupBroadcast(String lookupName,
                              Object callback)
                       throws Exception

Throws:

Exception

lookup

public Object lookup(String lookupName)
              throws Exception

Get a remote object from the server.

Parameters:

lookupName - name that the server has used to bind the object.

Throws:

Exception

getSocket

public Socket getSocket()

Get the real socket.

createBindName

protected String createBindName(RequestInfo ri)

create a name that will be unique on the server.

getProxyForCtoS

protected Object getProxyForCtoS(RequestInfo ri,
                                 String name,
                                 Class c,
                                 boolean bDontUseQueue)
                          throws Exception

Create a proxy instance for an Object that is on the server. This is used for lookups and when the server returns a remote instance. All methods that are called on the proxy will be sent to the server, and act as-if it were ran locally.

Throws:

Exception

getProxyForCtoS

protected Object getProxyForCtoS(String name,
                                 Class c,
                                 boolean bUsesQueue)
                          throws Exception

Throws:

Exception

getProxyForBroadcast

protected Object getProxyForBroadcast(String name,
                                      Class c,
                                      Object callback)
                               throws Exception

Throws:

Exception

onInvokeForCtoS

protected Object onInvokeForCtoS(BindInfo bind,
                                 Object proxy,
                                 Method method,
                                 Object[] args)
                          throws Throwable

Throws:

Throwable

afterInvokeForCtoS

protected void afterInvokeForCtoS(RequestInfo ri)

Called after a CtoS remote method is called.

_onInvokeForCtoS

protected boolean _onInvokeForCtoS(RequestInfo ri)
                            throws Exception

Called when a remote/proxy object method is invoked. The method info will be sent to the server, and return the method return value from the server.

Throws:

Exception

setMinimumSocketsForCtoS

public void setMinimumSocketsForCtoS(int x)

getMinimumSocketsForCtoS

public int getMinimumSocketsForCtoS()

setMaximumSocketsForCtoS

public void setMaximumSocketsForCtoS(int x)

getMaximumSocketsForCtoS

public int getMaximumSocketsForCtoS()

getVirtualSocketCtoSPool

protected OAPool<VirtualSocket> getVirtualSocketCtoSPool()

getSocketForCtoS

protected VirtualSocket getSocketForCtoS()
                                  throws Exception

Throws:

Exception

releaseSocketForCtoS

protected void releaseSocketForCtoS(VirtualSocket vs)
                             throws Exception

Throws:

Exception

createSocketForStoC

protected void createSocketForStoC()
                            throws Exception

These are vsockets used to listen/wait for method calls from server. This is used when a client sends a remote object to the server, so that server can then call methods on it, and have it invoked on the client. On the server, each client has a session that has a list of the StoC vsockets.

Throws:

Exception

onRemoteThreadCreated

protected void onRemoteThreadCreated(int totalCount,
                                     int liveCount)

processStoCSocket

protected RemoteObjectInputStream processStoCSocket(VirtualSocket socket,
                                                    int threadId,
                                                    RemoteObjectInputStream ois)
                                             throws Exception

Throws:

Exception

setupRequestQueueThread

protected void setupRequestQueueThread()

que that has a remoteThread process the request

setupSyncRequestQueueThread

protected void setupSyncRequestQueueThread()

que that is for sync requests, and sync return values/ack

setupSyncRunnableQueueThread

protected void setupSyncRunnableQueueThread()

createSyncRunnableQueueThread

protected void createSyncRunnableQueueThread()

processMessageForStoC

protected void processMessageForStoC(RequestInfo ri)
                              throws Exception

Throws:

Exception

sendResponseForStoC

protected void sendResponseForStoC(RequestInfo ri)
                            throws Exception

Throws:

Exception

afterInvokForStoC

public void afterInvokForStoC(RequestInfo ri)

called after a callback method from the server to a local remote object.

getBindInfo

protected BindInfo getBindInfo(String name)

Find the bind information based on unique name assigned to it.

performDGC

public void performDGC()

getBindInfoForObject

protected BindInfo getBindInfoForObject(Object obj)

This is used to be able to find the unique name given to a remote object.

getBindInfo

protected BindInfo getBindInfo(String name,
                               Object obj,
                               Class interfaceClass,
                               boolean bUsesQueue,
                               boolean bIsBroadcast)

Create information that is used to manage a remote object.

getBindInfo

protected BindInfo getBindInfo(RequestInfo ri,
                               String name,
                               Object obj,
                               Class interfaceClass,
                               boolean bDontUseQueue)

getMethodCallCount

public long getMethodCallCount()

number of remote methods called.

getReceivedMethodCount

public long getReceivedMethodCount()