@InterfaceAudience.Private public class ServerRpcController extends Object implements com.google.protobuf.RpcController
Service implementations.
When implementing Service defined methods,
coprocessor endpoints can use the following
pattern to pass exceptions back to the RPC client:
public void myMethod(RpcController controller, MyRequest request,
RpcCallback<MyResponse> done) {
MyResponse response = null;
try {
// do processing
response = MyResponse.getDefaultInstance(); // or use a new builder to populate the response
} catch (IOException ioe) {
// pass exception back up
ResponseConverter.setControllerException(controller, ioe);
}
done.run(response);
}
| Modifier and Type | Field and Description |
|---|---|
private String |
errorMessage |
private IOException |
serviceException
The exception thrown within
Service.callMethod(
Descriptors.MethodDescriptor, RpcController, Message, RpcCallback),
if any. |
| Constructor and Description |
|---|
ServerRpcController() |
| Modifier and Type | Method and Description |
|---|---|
void |
checkFailed()
Throws an IOException back out if one is currently stored.
|
String |
errorText() |
boolean |
failed() |
boolean |
failedOnException()
Returns whether or not a server exception was generated in the prior RPC invocation.
|
IOException |
getFailedOn()
Returns any exception thrown during service method invocation, or
null if no exception
was thrown. |
boolean |
isCanceled() |
void |
notifyOnCancel(com.google.protobuf.RpcCallback<Object> objectRpcCallback) |
void |
reset() |
void |
setFailed(String message) |
void |
setFailedOn(IOException ioe)
Sets an exception to be communicated back to the
Service client. |
void |
startCancel() |
private IOException serviceException
Service.callMethod(
Descriptors.MethodDescriptor, RpcController, Message, RpcCallback),
if any.private String errorMessage
public void reset()
reset in interface com.google.protobuf.RpcControllerpublic boolean failed()
failed in interface com.google.protobuf.RpcControllerpublic String errorText()
errorText in interface com.google.protobuf.RpcControllerpublic void startCancel()
startCancel in interface com.google.protobuf.RpcControllerpublic void setFailed(String message)
setFailed in interface com.google.protobuf.RpcControllerpublic boolean isCanceled()
isCanceled in interface com.google.protobuf.RpcControllerpublic void notifyOnCancel(com.google.protobuf.RpcCallback<Object> objectRpcCallback)
notifyOnCancel in interface com.google.protobuf.RpcControllerpublic void setFailedOn(IOException ioe)
Service client.ioe - the exception encountered during execution of the service methodpublic IOException getFailedOn()
null if no exception
was thrown. This can be used by clients to receive exceptions generated by RPC calls, even
when RpcCallbacks are used and no ServiceException is
declared.public boolean failedOnException()
public void checkFailed()
throws IOException
IOExceptionCopyright © 2007–2019 The Apache Software Foundation. All rights reserved.