From 90922c60df409f974b64d1b5076f21fb8787ae5f Mon Sep 17 00:00:00 2001 From: Daniel Verkamp Date: Wed, 11 Apr 2018 11:15:19 -0700 Subject: [PATCH] rpc: reword doc comments Change-Id: I4fa713afbb94ad0d0d61860f1bf9ab361eaa0dde Signed-off-by: Daniel Verkamp Reviewed-on: https://review.gerrithub.io/407360 Reviewed-by: Ben Walker Tested-by: SPDK Automated Test System Reviewed-by: Jim Harris Reviewed-by: Dariusz Stojaczyk Reviewed-by: Changpeng Liu --- include/spdk/rpc.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/spdk/rpc.h b/include/spdk/rpc.h index 4516590d6..4053f2acb 100644 --- a/include/spdk/rpc.h +++ b/include/spdk/rpc.h @@ -43,7 +43,7 @@ extern "C" { #endif /** - * Listen on the required address. + * Start listening for RPC connections. * * \param listen_addr Listening address. * @@ -52,17 +52,17 @@ extern "C" { int spdk_rpc_listen(const char *listen_addr); /** - * Poll the RPC server for accepting the request. + * Poll the RPC server. */ void spdk_rpc_accept(void); /** - * Close the RPC server. + * Stop listening for RPC connections. */ void spdk_rpc_close(void); /** - * Function to handle the RPC request. + * Function signature for RPC request handlers. * * \param request RPC request to handle. * \param params Parameters associated with the RPC request. @@ -71,7 +71,7 @@ typedef void (*spdk_rpc_method_handler)(struct spdk_jsonrpc_request *request, const struct spdk_json_val *params); /** - * Register the RPC method. + * Register an RPC method. * * \param method Name for the registered method. * \param func Function registered for this method to handle the RPC request.