Package gnu.cajo.utils.extra
Class AsyncMethod
java.lang.Object
gnu.cajo.utils.extra.AsyncMethod
- All Implemented Interfaces:
Invoke
,Serializable
,Remote
This class is used to asynchronously invoke methods on objects. Each time
the invoke method is called, it spawns a one-use thread, to perform the
method invocation. From the perspective of the caller, the method returns
immediately. When the invocation is completed, it will callback the
provided listening object; invoking a method of the identical name as the
one invoked on the called object; passing a single object argument, which
is either the resulting data of the invocation, if any, or the exception
resulting from the invocation. Canonically the callback object should
therfore define up to three methods; each having the name of the method
called. One method accepting no arguments, one receiving the expected
result object, and one accepting an Exception argument. The callback can
be null, in which case the asynchronous invocation result will be
silently discarded.
This class can be used in either of two fundamentally different ways:
- An instance can be constructed for a given called object, and its corresponding callback object, for repeated use.
- The static invoke method can be used for infrequent combinations of called objects and callbacks.
- Version:
- 1.0, 22-Jan-06 Initial release
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionAsyncMethod
(Object item, Object callback) The constructor takes any object, and allows its methods to be invoked asynchronously; then calls back the listening object, with the result of the invocation. -
Method Summary
Modifier and TypeMethodDescriptionstatic void
This method invokes the method specified, on the object specified, with the argument(s) specified, if any, asynchronously.This method invokes the method specified, with the argument(s) specified, if any, asynchronously.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
item
This is the reference to the object, usually remote, on which to invoke asynchronously. It works on local objects as well. -
callback
This is the reference to the object, local or remote, which to call back asynchronously, when the invocation has completed. (if non-null)
-
-
Constructor Details
-
AsyncMethod
The constructor takes any object, and allows its methods to be invoked asynchronously; then calls back the listening object, with the result of the invocation.- Parameters:
item
- The object to make asynchronously callable. It may be an any arbitrary object, of any type, local or remote.callback
- The object to asynchronously call back, on the completion of the asynchronous method call. It may be any arbitrary object, of any type, local or remote. If the argument is null, the asynchronous invocations result will silently be silently discarded.
-
-
Method Details
-
invoke
This method invokes the method specified, with the argument(s) specified, if any, asynchronously.- Specified by:
invoke
in interfaceInvoke
- Parameters:
method
- The name of the method of the member object to be invoked asynchronously.args
- The argument, or arguments, to be provided to the method. The paramater can be null, if the method takes none, or it can be an array of objects, if the method takes several. In actuality, this method simply invokes the static invoke method of this class, providing its local item and callback objects, to centralise the asynchronous invocation processing.- Returns:
- null No return is provided, it is required to fulfill the Invoke interface.
-
invoke
This method invokes the method specified, on the object specified, with the argument(s) specified, if any, asynchronously. It then calls the callback object specified, if any.- Parameters:
item
- The object on which to invoke the method asynchronously. It may be any arbitrary object, of any type, local or remote.method
- The name of the method on the called object to be invoked asynchronously.args
- The argument, or arguments, to be provided to the method. The paramater can be null, if the method takes none, or it can be an array of objects, when the method takes several.callback
- The object to asynchronously call back, on the completion of the asynchronous method call. It may be any arbitrary object, of any type, local or remote. If the argument is null, the invocation result will be silently discarded.
-