com.viaoa.remote.multiplexer

Class RemoteMultiplexerServer

java.lang.Object

com.viaoa.remote.multiplexer.RemoteMultiplexerServer

public class RemoteMultiplexerServer
extends Object

Server component used to allow remoting method calls with Clients. Uses a MultiplexerServer for communication with clients.

Different ways to create a remote object:

1. Server can bind an Object so that clients can then do a lookup to get the object, and all method calls will be invoked on the server.
2. A method that has a remote class parameter. This can be used by client or server - where a method argument is a remote object.
3. A method returns a remote class. This can be used by client or server - where a method returns a remote object.
4. The server can create a single remote object, that will then "broadcast" to all clients that have it.

Note: OARemoteThread is used to process requests.

Author:

vvia

Constructor Summary

Constructors

Constructor and Description
RemoteMultiplexerServer(MultiplexerServer server) Create a new RemoteServer using multiplexer.

Method Summary

Modifier and Type	Method and Description
protected void	_invokeByRemoteThread(OARemoteThread rt, RequestInfo ri, com.viaoa.remote.multiplexer.RemoteMultiplexerServer.Session session)
protected void	afterInvokeForCtoS(RequestInfo ri) Called after a CtoS remote method is called.
protected void	afterInvokeForStoC(RequestInfo ri) Called after a StoC remote method is called.
Object	createBroadcast(String bindName, Class interfaceClass, String queueName, int queueSize)
Object	createBroadcast(String bindName, Object callback, Class interfaceClass, String queueName, int queueSize) Allows sending messages to server and all clients.
void	createLookup(String name, Object obj, Class interfaceClass) Register/Bind an Object so that it can be used by clients
void	createLookup(String name, Object obj, Class interfaceClass, String queueName, int queueSize)
protected Object	createProxyForStoC(com.viaoa.remote.multiplexer.RemoteMultiplexerServer.Session session, Class c, String bindName) This will create a server side proxy instance for a remote object sent from a client.
void	createSession(Socket socket, int connectionId) This can be called when MultiplexerServer.onClientConnect(..) is called.
protected BindInfo	getBindInfo(BindInfo biParent, String name, Object obj, Class interfaceClass, boolean bDontUseQueue)
protected BindInfo	getBindInfo(BindInfo biParent, String name, Object obj, Class interfaceClass, boolean bIsBroadcast, String queueName, int queueSize, boolean bDontUseQueue)
protected BindInfo	getBindInfo(Object obj) Get the Bind information for a remote object.
protected BindInfo	getBindInfo(String name) Get the Bind information for the name assigned to a remote object.
protected BindInfo	getBindInfo(String name, Object obj, Class interfaceClass, String queueName, int queueSize)
long	getMethodCallCount() number of remote methods called.
MultiplexerServer	getMultiplexerServer()
long	getQueueHeadPos()
long	getReceivedMethodCount()
com.viaoa.remote.multiplexer.RemoteMultiplexerServer.Session	getSession(int connectionId, boolean bCreateIfNull)
protected void	invokeUsingRemoteThread(RequestInfo ri, boolean bFromServerQueueThread) This will have the currentThread wait for a RemoteThread to process the request using invokeCtoS _invokeCtoS
protected void	notifyMethodInvoked(RequestInfo ri)
protected void	notifyProcessedByServer(RequestInfo ri)
protected void	onException(int connectionId, String title, String msg, Exception e, boolean bWillDisconnect)
protected RequestInfo	onInvokeBroadcast(BindInfo bind, Method method, Object[] args)
protected Object	onInvokeForStoC(Object proxyInstance, com.viaoa.remote.multiplexer.RemoteMultiplexerServer.Session session, String bindName, Method method, Object[] args)
protected void	onNewConnectionForCtoS(Socket socket)
protected void	onNewConnectionForStoC(Socket socket) a client has created a new server to client (StoC) vsocket, that can be used for the server to call methods on a client's remote object.
void	performDGC()
protected void	processSocketCtoS(VirtualSocket socket)
boolean	removeLookup(String name) Remove an object that was previously used for a bind.
void	removeSession(int connectionId) This can be called when MultiplexerServer.onClientDisconnect(..) is called.
protected void	setupBroadcastQueueReader(String asyncQueueName, String bindName)
void	start() starts serverSockets for remote messages.
protected void	startServerSocketForCtoS()
protected void	startServerSocketForStoC() VServerSocket that is used for vsockets that are used when a method is called on the server that needs to be invoked on the client where the object came from.
protected boolean	waitForMethodInvoked(RequestInfo ri)
protected boolean	waitForMethodInvoked(RequestInfo ri, int maxSeconds)
protected void	waitForProcessedByServer(RequestInfo ri)

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteMultiplexerServer

public RemoteMultiplexerServer(MultiplexerServer server)

Create a new RemoteServer using multiplexer.

See Also:

to have the server allow for client connections., to have this server start recieving remote calls.

Method Detail

getMultiplexerServer

public MultiplexerServer getMultiplexerServer()

removeSession

public void removeSession(int connectionId)

This can be called when MultiplexerServer.onClientDisconnect(..) is called. If this is not called, then the next socket.IO method will throw an IOException.

See Also:

MultiplexerServer.onClientDisconnect(int)

createSession

public void createSession(Socket socket,
                          int connectionId)

This can be called when MultiplexerServer.onClientConnect(..) is called.

See Also:

MultiplexerServer.onClientConnect(java.net.Socket, int)

getSession

public com.viaoa.remote.multiplexer.RemoteMultiplexerServer.Session getSession(int connectionId,
                                                                               boolean bCreateIfNull)

start

public void start()
           throws Exception

starts serverSockets for remote messages.

Throws:

Exception

See Also:

to have the server allow for client connections.

startServerSocketForCtoS

protected void startServerSocketForCtoS()
                                 throws Exception

Throws:

Exception

onNewConnectionForCtoS

protected void onNewConnectionForCtoS(Socket socket)

processSocketCtoS

protected void processSocketCtoS(VirtualSocket socket)
                          throws Exception

Throws:

Exception

afterInvokeForCtoS

protected void afterInvokeForCtoS(RequestInfo ri)

Called after a CtoS remote method is called.

startServerSocketForStoC

protected void startServerSocketForStoC()
                                 throws Exception

VServerSocket that is used for vsockets that are used when a method is called on the server that needs to be invoked on the client where the object came from.

Throws:

Exception

onNewConnectionForStoC

protected void onNewConnectionForStoC(Socket socket)

a client has created a new server to client (StoC) vsocket, that can be used for the server to call methods on a client's remote object.

createProxyForStoC

protected Object createProxyForStoC(com.viaoa.remote.multiplexer.RemoteMultiplexerServer.Session session,
                                    Class c,
                                    String bindName)

This will create a server side proxy instance for a remote object sent from a client.

onInvokeForStoC

protected Object onInvokeForStoC(Object proxyInstance,
                                 com.viaoa.remote.multiplexer.RemoteMultiplexerServer.Session session,
                                 String bindName,
                                 Method method,
                                 Object[] args)
                          throws Exception

Throws:

Exception

afterInvokeForStoC

protected void afterInvokeForStoC(RequestInfo ri)

Called after a StoC remote method is called.

performDGC

public void performDGC()

createLookup

public void createLookup(String name,
                         Object obj,
                         Class interfaceClass)

Register/Bind an Object so that it can be used by clients

Parameters:

name -

obj - remote object to create

interfaceClass - Important: a weakref is used to store the remote object "obj"

createLookup

public void createLookup(String name,
                         Object obj,
                         Class interfaceClass,
                         String queueName,
                         int queueSize)

Parameters:

name -

obj -

interfaceClass -

queueName - used to have return value use an async circular queue for responses.

queueSize -

removeLookup

public boolean removeLookup(String name)

Remove an object that was previously used for a bind.

getBindInfo

protected BindInfo getBindInfo(String name)

Get the Bind information for the name assigned to a remote object.

getBindInfo

protected BindInfo getBindInfo(Object obj)

Get the Bind information for a remote object.

getBindInfo

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

getBindInfo

protected BindInfo getBindInfo(String name,
                               Object obj,
                               Class interfaceClass,
                               String queueName,
                               int queueSize)

getBindInfo

protected BindInfo getBindInfo(BindInfo biParent,
                               String name,
                               Object obj,
                               Class interfaceClass,
                               boolean bIsBroadcast,
                               String queueName,
                               int queueSize,
                               boolean bDontUseQueue)

createBroadcast

public Object createBroadcast(String bindName,
                              Class interfaceClass,
                              String queueName,
                              int queueSize)

createBroadcast

public Object createBroadcast(String bindName,
                              Object callback,
                              Class interfaceClass,
                              String queueName,
                              int queueSize)

Allows sending messages to server and all clients.

Parameters:

bindName - name for clients to use to lookup the object

callback - object to use when receiving a broadcast from a client

interfaceClass -

queueName - name of circularQueue used to hold messages

queueSize - size of circularQueue

Returns:

proxy instance where all methods will be sent to and invoked on all clients see RemoteMultiplexerClient#createBroadcastProxy(String, Object)

onInvokeBroadcast

protected RequestInfo onInvokeBroadcast(BindInfo bind,
                                        Method method,
                                        Object[] args)
                                 throws Exception

Throws:

Exception

setupBroadcastQueueReader

protected void setupBroadcastQueueReader(String asyncQueueName,
                                         String bindName)

invokeUsingRemoteThread

protected void invokeUsingRemoteThread(RequestInfo ri,
                                       boolean bFromServerQueueThread)
                                throws Exception

This will have the currentThread wait for a RemoteThread to process the request using invokeCtoS _invokeCtoS

Throws:

Exception

_invokeByRemoteThread

protected void _invokeByRemoteThread(OARemoteThread rt,
                                     RequestInfo ri,
                                     com.viaoa.remote.multiplexer.RemoteMultiplexerServer.Session session)
                              throws Exception

Throws:

Exception

onException

protected void onException(int connectionId,
                           String title,
                           String msg,
                           Exception e,
                           boolean bWillDisconnect)

notifyMethodInvoked

protected void notifyMethodInvoked(RequestInfo ri)

waitForMethodInvoked

protected boolean waitForMethodInvoked(RequestInfo ri)

waitForMethodInvoked

protected boolean waitForMethodInvoked(RequestInfo ri,
                                       int maxSeconds)

notifyProcessedByServer

protected void notifyProcessedByServer(RequestInfo ri)

waitForProcessedByServer

protected void waitForProcessedByServer(RequestInfo ri)

getMethodCallCount

public long getMethodCallCount()

number of remote methods called.

getReceivedMethodCount

public long getReceivedMethodCount()

getQueueHeadPos

public long getQueueHeadPos()