org.universAAL.ri.gateway.utils

Class CallSynchronizer<ID,INPUT,OUTPUT>

java.lang.Object

org.universAAL.ri.gateway.utils.CallSynchronizer<ID,INPUT,OUTPUT>

public abstract class CallSynchronizer<ID,INPUT,OUTPUT>
extends Object

A Helper class that enables to perform calls and wait for the asynchronous response.

Author:

amedrano

Constructor Summary

Constructors

Constructor and Description
CallSynchronizer() Constructor.
CallSynchronizer(long timeout) Constructor.

Method Summary

Modifier and Type	Method and Description
void	abortCall(ID id) Abort the call with the given ID.
protected abstract void	operate(ID callerID, INPUT input) This method operates the call, it performs the adequate operations to ensure there will be a response calling on another thread.
OUTPUT	performCall(ID callerID, INPUT input) This method is the main method to syncronize the caller thread.
void	performResponse(ID id, OUTPUT output) When a response for a call is found, this method should be used to notify the Caller Thread waiting for it.
void	purge() When there will be no more responses this method aborts all calls,

Methods inherited from class java.lang.Object

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

Constructor Detail

CallSynchronizer

public CallSynchronizer(long timeout)

Constructor.

CallSynchronizer

public CallSynchronizer()

Constructor.

Method Detail

performCall

public OUTPUT performCall(ID callerID,
                          INPUT input)
                   throws InterruptedException,
                          TimeoutException

This method is the main method to syncronize the caller thread. The caller Thread will be stoped until another thread calls CallSynchronizer#performResponse(ID, Object).

Parameters:

callerID - the Id to identify the call.

input - The input needed to perform the call.

Returns:

the call response.

Throws:

InterruptedException - when the call was aborted by other thread.

TimeoutException - when the timeout wait limit for response has been exceeded.

See Also:

CallSynchronizer#performResponse(ID, Object)

operate

protected abstract void operate(ID callerID,
                                INPUT input)

This method operates the call, it performs the adequate operations to ensure there will be a response calling on another thread.

Parameters:

callerID - the call identifier

input - the input needed for the call

performResponse

public void performResponse(ID id,
                            OUTPUT output)

When a response for a call is found, this method should be used to notify the Caller Thread waiting for it.

Parameters:

id -

output -

abortCall

public void abortCall(ID id)

Abort the call with the given ID. it unblocks the call and the performCall(Object, Object) will throw a InterruptedException.

Parameters:

id -

purge

public void purge()

When there will be no more responses this method aborts all calls,