This is an automated email from the ASF dual-hosted git repository. awong pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/kudu.git
commit 5b2287aa3c1a2858f918aec25054eb9ce523572e Author: Alexey Serbin <[email protected]> AuthorDate: Sun Jan 3 18:27:30 2021 -0800 [docs] RPC cancellation is now implemented This patch updates the documentation on the RPC design in rpc.md, refreshing the note on the RPC cancellation. Since KUDU-2065 has been addressed, it's now possible to cancel a remote call using the RpcController::Cancel() method (follow up JIRAs KUDU-2334 and KUDU-2011 are still open, but the functionality for RPC cancellation is there). Change-Id: I335b3c0fd965896aff7e1625fd01ae564c050b1a Reviewed-on: http://gerrit.cloudera.org:8080/16918 Tested-by: Kudu Jenkins Reviewed-by: Grant Henke <[email protected]> --- docs/design-docs/rpc.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/design-docs/rpc.md b/docs/design-docs/rpc.md index 474962d..988b065 100644 --- a/docs/design-docs/rpc.md +++ b/docs/design-docs/rpc.md @@ -93,12 +93,12 @@ currently this is just timeout functionality, but in the future may include other call properties such as tracing information, priority classes, deadline propagation, etc. -Upon issuing the asynchronous request, the RPC layer enqueues the call to be sent -to the server and immediately returns. During this period, the caller thread -may continue to send other RPCs or perform other processing while waiting for -the callback to be triggered. In the future, we will provide an RPC cancellation -function on the RpcController object in case the user determines that the call -is no longer required. +Upon issuing the asynchronous request, the RPC layer enqueues the call to be +sent to the server and immediately returns. During this period, the caller +thread may continue to send other RPCs or perform other processing while +waiting for the callback to be triggered. In addition, it's possible to cancel +the RPC using the RpcController::Cancel() method if the user determines that +the call is no longer required. When the call completes, the RPC layer will invoke the provided ResponseCallback function from within the context of the reactor thread. Given this, @@ -130,8 +130,8 @@ The generated ServiceIf class contains pure virtual methods for each of the RPCs in the service. Each method to be implemented has an API like: ``` - void MethodName(const RequestPB *req, - ResponsePB *resp, ::kudu::rpc::RpcContext *context); + void MethodName( + const RequestPB* req, ResponsePB* resp, ::kudu::rpc::RpcContext* context); ``` The request PB is the user-provided request, and the response PB is a cleared
