Commit 90922c60 authored by Daniel Verkamp's avatar Daniel Verkamp
Browse files

rpc: reword doc comments 



Change-Id: I4fa713afbb94ad0d0d61860f1bf9ab361eaa0dde
Signed-off-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-on: https://review.gerrithub.io/407360


Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
Reviewed-by: default avatarDariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
parent 7d45cfc3

include/spdk/rpc.h

+5 −5
Original line number Diff line number Diff line
@@ -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.