xroad_signal.h File Reference

#include <stdint.h>
#include "xroad_common_types.h"

Include dependency graph for xroad_signal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	xroad_signal_callback_s

Typedefs
typedef struct xroad_signal_s	xroad_signal_t
typedef struct xroad_signal_callback_s	xroad_signal_callback_t

Functions
xroad_signal_t *	xroad_signal_create (xroad_signal_callback_t cb)
xroad_errno_t	xroad_signal_catch (xroad_signal_t *s, int32_t signal)
xroad_errno_t	xroad_signal_free (xroad_signal_t *s, int32_t signal)
void	xroad_signal_destroy (xroad_signal_t *s)

Detailed Description

Author

Dmitry S. Melnikov, dmitr.nosp@m.yme@.nosp@m.gmail.nosp@m..com

Typedef Documentation

xroad_signal_callback_t

typedef struct xroad_signal_callback_s xroad_signal_callback_t

signal callback

Function Documentation

xroad_signal_catch()

xroad_errno_t xroad_signal_catch	(	xroad_signal_t *	s,
		int32_t	signal
	)

catch signal

Parameters

[in]	s	- signal handler instance
[in]	signal	- signal number to catch

Returns

XROAD_OK - catched, else failed

xroad_signal_create()

xroad_signal_t* xroad_signal_create

(

xroad_signal_callback_t

cb

)

create new signal handler

Parameters

[in]

cb

- signal callback

Returns

created signal, NULL - error happened

xroad_signal_destroy()

void xroad_signal_destroy

(

xroad_signal_t *

s

)

destroy signal handler

Parameters

[in]

s

- signal handler to destroy

xroad_signal_free()

xroad_errno_t xroad_signal_free	(	xroad_signal_t *	s,
		int32_t	signal
	)

free signal

Parameters

[in]	s	- signal handler instance
[in]	signal	- signal number to free

Returns

XROAD_OK - freed, else failed