include/event.h: add comments for callback functions
Change-Id: Ie29d7cc3e155628f92c5ffae9d0b3e8cb0989ebe Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com> Reviewed-on: https://review.gerrithub.io/407704 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: GangCao <gang.cao@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
parent
0054af55c9
commit
51806fa7b6
@ -51,6 +51,12 @@
|
|||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Event handler function.
|
||||||
|
*
|
||||||
|
* \param arg1 Argument 1.
|
||||||
|
* \param arg2 Argument 2.
|
||||||
|
*/
|
||||||
typedef void (*spdk_event_fn)(void *arg1, void *arg2);
|
typedef void (*spdk_event_fn)(void *arg1, void *arg2);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -63,8 +69,17 @@ struct spdk_event;
|
|||||||
*/
|
*/
|
||||||
struct spdk_poller;
|
struct spdk_poller;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Callback function for customized shutdown handling of application.
|
||||||
|
*/
|
||||||
typedef void (*spdk_app_shutdown_cb)(void);
|
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"
|
#define SPDK_DEFAULT_RPC_ADDR "/var/tmp/spdk.sock"
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user