xroad_event.h File Reference

#include <stdint.h>
#include <sys/eventfd.h>
#include "xroad_common_types.h"

Include dependency graph for xroad_event.h:

Go to the source code of this file.

Classes
struct	xroad_event_callback_s

Macros
#define	XROAD_EVENT_AS_SEMAPHORE   EFD_SEMAPHORE
#define	__xroad_event_dtor__   __dtor__(xroad_event_destructor)

Typedefs
typedef struct xroad_event_s	xroad_event_t
typedef struct xroad_event_callback_s	xroad_event_callback_t

Functions
xroad_event_t *	xroad_event_create (xroad_event_callback_t cb, uint32_t init_val, int32_t flags)
void	xroad_event_destroy (xroad_event_t *e)
void	xroad_event_destructor (xroad_event_t **evt)
xroad_errno_t	xroad_event_fire (xroad_event_t *e, int64_t val)

Detailed Description

Author

Dmitry S. Melnikov, dmitr.nosp@m.yme@.nosp@m.quant.nosp@m.box..nosp@m.com

Macro Definition Documentation

__xroad_event_dtor__

#define __xroad_event_dtor__   __dtor__(xroad_event_destructor)

automatic destructor

Typedef Documentation

xroad_event_callback_t

typedef struct xroad_event_callback_s xroad_event_callback_t

event callback

Function Documentation

xroad_event_create()

xroad_event_t* xroad_event_create	(	xroad_event_callback_t	cb,
		uint32_t	init_val,
		int32_t	flags
	)

create new event handler

Parameters

[in]	cb	- event callback
	[in[	init_val - initial event value
[in]	flags	- event flags see defines at the top

Returns

created event handler, NULL - error happened

xroad_event_destroy()

void xroad_event_destroy

(

xroad_event_t *

e

)

destroy event handler

Parameters

[in]

e

- event handler instance

xroad_event_fire()

xroad_errno_t xroad_event_fire	(	xroad_event_t *	e,
		int64_t	val
	)

fire event

Parameters

[in]	e	- event handler instance
[in]	val	- value to fire

Returns

XROAD_OK -fired, else failed