Commit a3cb5fa5 authored by Yanbo Zhou's avatar Yanbo Zhou Committed by Jim Harris
Browse files

include/rpc.h: add comments for public APIs 



Change-Id: I0f8adc8a9045d9d1817483122a023d5dda04fb3b
Signed-off-by: default avatarYanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/401966


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarGangCao <gang.cao@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent da002ddb

include/spdk/rpc.h

+27 −0
Original line number Original line Diff line number Diff line
@@ -42,13 +42,40 @@ 
extern "C" {

extern "C" {

#endif

#endif





/**

 * Listen on the required address.

 *

 * \param listen_addr Listening address.

 *

 * \return 0 on success, -1 on failure.

 */

int spdk_rpc_listen(const char *listen_addr);

int spdk_rpc_listen(const char *listen_addr);



/**

 * Poll the RPC server for accepting the request.

 */

void spdk_rpc_accept(void);

void spdk_rpc_accept(void);



/**

 * Close the RPC server.

 */

void spdk_rpc_close(void);

void spdk_rpc_close(void);





/**

 * Function to handle the RPC request.

 *

 * \param request RPC request to handle.

 * \param params Parameters associated with the RPC request.

 */

typedef void (*spdk_rpc_method_handler)(struct spdk_jsonrpc_request *request,

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.

 *

 * \param method Name for the registered method.

 * \param func Function registered for this method to handle the RPC request.

 */

void spdk_rpc_register_method(const char *method, spdk_rpc_method_handler func);

void spdk_rpc_register_method(const char *method, spdk_rpc_method_handler func);





#define SPDK_RPC_REGISTER(method, func) \

#define SPDK_RPC_REGISTER(method, func) \