org.youscope.common.callback

Interface Callback

All Superinterfaces:

java.rmi.Remote

All Known Subinterfaces:

DropletMicrofluidicJobCallback, LiveModifiableJobCallback, RemoteScriptEngine, UserControlMeasurementCallback, WaitForUserCallback

public interface Callback
extends java.rmi.Remote

A measurement callback can be used by a measurement to gain control over functionality at creation time. Typically, it is used by measurements (which run on the YouScope's server) to be able to trigger certain behavior on the client side, e.g. to wait for a certain user input. The client therefore passes the provider to the server when creating a new measurement. Measurements or jobs can then ask the provider for a certain functionality, represented by a type identifier. If the functionality is available, an object implementing the interface is returned, which can be used for communication proposes. In general, measurements should not depend on callbacks. A measurement should run on the server even if a callback is not available, or if the connection to the client breaks down (e.g. because the client is closed, while the server should still run). Furthermore, the callback should not perform parts of the measurement itself, like controlling the microscope, or similar.

Author:

Moritz Lang

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTypeIdentifier() Returns an identifier of the type of this callback.
void	initializeCallback(java.io.Serializable... arguments) Has to be called by the measurement component upon initialization prior to using any functionality of the callback (except pingCallback()).
void	pingCallback() Checks the connection to the callback.
void	uninitializeCallback() Has to be called by the measurement component upon uninitialization.

Method Detail

pingCallback

void pingCallback()
           throws java.rmi.RemoteException

Checks the connection to the callback. The implementation should be empty, i.e. return immediately without any action. The function can thus be used by a measurement to check if the callback is still available.

Throws:

java.rmi.RemoteException

initializeCallback

void initializeCallback(java.io.Serializable... arguments)
                 throws java.rmi.RemoteException,
                        CallbackException

Has to be called by the measurement component upon initialization prior to using any functionality of the callback (except pingCallback()).

Parameters:

arguments - Optional arguments to be send to the callback.

Throws:

java.rmi.RemoteException

CallbackException

uninitializeCallback

void uninitializeCallback()
                   throws java.rmi.RemoteException,
                          CallbackException

Has to be called by the measurement component upon uninitialization. After calling this function, no functionality of the callback is allowed to be used anymore (except pingCallback()) until re-initialization.

Throws:

java.rmi.RemoteException

CallbackException

getTypeIdentifier

java.lang.String getTypeIdentifier()
                            throws java.rmi.RemoteException

Returns an identifier of the type of this callback.

Returns:

Type identifier of callback.

Throws:

java.rmi.RemoteException