org.fujion.ipc

Class InvocationRequestQueue

java.lang.Object

org.fujion.ipc.InvocationRequestQueue

public class InvocationRequestQueue
extends Object

This class implements a queue that allows one page to execute methods on a target on another page (the owner of the queue) via invocation requests.

Constructor Summary

Constructors

Constructor and Description
InvocationRequestQueue(String name, BaseComponent target, InvocationRequest onClose) Create an invocation request queue for the specified target.
InvocationRequestQueue(String name, Page page, Object target, InvocationRequest onClose) Create an invocation request queue for the specified page and target.

Method Summary

Modifier and Type	Method and Description
void	close() Close the invocation queue.
String	getName() Returns the unique name for this queue.
boolean	isAlive() Returns true if this queue is alive.
void	sendRequest(InvocationRequest request) Queue a request on the owning page's event queue..
void	sendRequest(String methodName, Object... args) Queue a request.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvocationRequestQueue

public InvocationRequestQueue(String name,
                              BaseComponent target,
                              InvocationRequest onClose)

Create an invocation request queue for the specified target.

Parameters:

name - Unique name for this queue.

target - Target of invocation requests sent to the queue.

onClose - Invocation request to send to the target upon queue closure (may be null).

InvocationRequestQueue

public InvocationRequestQueue(String name,
                              Page page,
                              Object target,
                              InvocationRequest onClose)

Create an invocation request queue for the specified page and target.

Parameters:

name - Unique name for this queue.

page - Page instance that owns the queue.

target - Target upon which invocations will operate.

onClose - Invocation request to send to the target upon queue closure (may be null).

Method Detail

getName

public String getName()

Returns the unique name for this queue.

Returns:

The queue's unique name.

close

public void close()

Close the invocation queue.

sendRequest

public void sendRequest(String methodName,
                        Object... args)

Queue a request.

Parameters:

methodName - Name of method to invoke on the target.

args - Arguments to pass to the invoked method.

sendRequest

public void sendRequest(InvocationRequest request)

Queue a request on the owning page's event queue..

Parameters:

request - The request.

isAlive

public boolean isAlive()

Returns true if this queue is alive.

Returns:

True if this queue is alive.