ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rpc: reword doc comments

Browse Source 
Change-Id: I4fa713afbb94ad0d0d61860f1bf9ab361eaa0dde
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-on: https://review.gerrithub.io/407360
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
This commit is contained in:
Daniel Verkamp 2018-04-11 11:15:19 -07:00
parent 7d45cfc3cc
commit 90922c60df
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/spdk/rpc.h
View File

@ -43,7 +43,7 @@ extern "C" {
#endif #endif
/** /**
* Listen on the required address. * Start listening for RPC connections.
* *
* \param listen_addr Listening address. * \param listen_addr Listening address.
* *
@ -52,17 +52,17 @@ extern "C" {
int spdk_rpc_listen(const char *listen_addr); 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); void spdk_rpc_accept(void);
/** /**
* Close the RPC server. * Stop listening for RPC connections.
*/ */
void spdk_rpc_close(void); void spdk_rpc_close(void);
/** /**
* Function to handle the RPC request. * Function signature for RPC request handlers.
* *
* \param request RPC request to handle. * \param request RPC request to handle.
* \param params Parameters associated with the RPC request. * \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); const struct spdk_json_val *params);
/** /**
* Register the RPC method. * Register an RPC method.
* *
* \param method Name for the registered method. * \param method Name for the registered method.
* \param func Function registered for this method to handle the RPC request. * \param func Function registered for this method to handle the RPC request.