rsb.patterns

Class DataCallback<ReplyType,RequestType>

java.lang.Object

rsb.patterns.DataCallback<ReplyType,RequestType>

Type Parameters:

ReplyType - The type of data produced as replies to the implemented functionality.

RequestType - The type of data required as request parameter

All Implemented Interfaces:

Callback

public abstract class DataCallback<ReplyType,RequestType>
extends Object
implements Callback

Implement the user behavior for a LocalServer method with a simple signature without events. This makes implementing callbacks simple, because no RSB Event instances need to be used. However, this e.g. prevents setting timestamps or further meta data of events. If you need such a behavior, please use EventCallback. In case you either do not need a request paramter or do not return any data, specify the respective java generics parameter as Void. You can then safely return null if you have no result. In other cases, null is explicitly not allowed. TODO check the null assumption

Author:

jmoringe, jwienke

Nested Class Summary

Nested classes/interfaces inherited from interface rsb.patterns.Callback

Callback.UserCodeException

Constructor Summary

Constructors

Constructor and Description
DataCallback()

Method Summary

Methods

Modifier and Type	Method and Description
Event	internalInvoke(Event request) Method to invoke the Callback's functionality.
abstract ReplyType	invoke(RequestType request) This method is called to invoke the actual behavior of an exposed method.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataCallback

public DataCallback()

Method Detail

internalInvoke

public Event internalInvoke(Event request)
                     throws Callback.UserCodeException

Description copied from interface: Callback

Method to invoke the Callback's functionality. This method can be considered an internal implementation detail.

Specified by:

internalInvoke in interface Callback

Parameters:

request - the request received from a RemoteServer method call

Returns:

an event with the result data of a method

Throws:

Callback.UserCodeException - any exception in the user code invoked by the callback

invoke

public abstract ReplyType invoke(RequestType request)
                          throws Exception

This method is called to invoke the actual behavior of an exposed method.

Parameters:

request - The argument passed to the associated method by the remote caller.

Returns:

A result that should be returned to the remote caller as the result of the calling the method.

Throws:

Exception - Can throw anything.