Commit 51806fa7 authored by Yanbo Zhou's avatar Yanbo Zhou Committed by Daniel Verkamp
Browse files

include/event.h: add comments for callback functions 



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


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarGangCao <gang.cao@intel.com>
Reviewed-by: default avatarShuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent 0054af55

include/spdk/event.h

+16 −1
Original line number Diff line number Diff line
@@ -51,6 +51,12 @@ 
extern "C" {

#endif



/**

 * Event handler function.

 *

 * \param arg1 Argument 1.

 * \param arg2 Argument 2.

 */

typedef void (*spdk_event_fn)(void *arg1, void *arg2);



/**
@@ -63,8 +69,17 @@ struct spdk_event; 
 */

struct spdk_poller;



/**

 * Callback function for customized shutdown handling of application.

 */

typedef void (*spdk_app_shutdown_cb)(void);

typedef void (*spdk_sighandler_t)(int);



/**

 * Signal handler fucntion.

 *

 * \param signal Signal number.

 */

typedef void (*spdk_sighandler_t)(int signal);



#define SPDK_DEFAULT_RPC_ADDR "/var/tmp/spdk.sock"