org.msgpack.rpc.Callback Maven / Gradle / Ivy
The newest version!
//
// MessagePack-RPC for Java
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package org.msgpack.rpc;
/**
* Callback interface for RPC methods. Use this interface to mark a method
* exposed on a RPC handler as asynchronous. If the methods first parameter is
* assignable from {@link Callback} the server won't explicitly wait for the
* methods execution, instead the executed method is responsible for triggering
* a response by calling one of the callbacks methods.
*
* Example:
*
*
* class RPCServer {
* public void doAsync(Callback callback, String action) {
* // do some action
* if (success)
* callback.run(actionResult);
* else
* callback.onError(null, "failed"):
* }
*
*/
public interface Callback {
/**
* Passes the methods result back to the caller.
*
* @param result
* the methods result
*/
public void sendResult(T result);
/**
* Passes the result and an object representing the error back to the caller
* in the case of an exception.
*
* @param error
* the error
* @param result
* the result if any
*/
public void sendError(Object error, T result);
}