xroad_time_list.h File Reference

#include <common/xroad_time.h>
#include <common/xroad_string.h>

Include dependency graph for xroad_time_list.h:

Go to the source code of this file.

Classes
struct	xroad_time_list_callback_t

Typedefs
typedef struct xroad_time_list_s	xroad_time_list_t

Functions
xroad_time_list_t *	xroad_time_list_create ()
void	xroad_time_list_destroy (xroad_time_list_t *tlist)
xroad_errno_t	xroad_time_list_add_event (xroad_time_list_t *tlist, xroad_time_t event_time, xroad_str_t event_name, xroad_time_list_callback_t cback)
xroad_errno_t	xroad_time_list_del_event (xroad_time_list_t *tlist, xroad_time_t event_time, xroad_str_t event_name)
void	xroad_time_list_clear (xroad_time_list_t *tlist)

Detailed Description

Author

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

Function Documentation

xroad_time_list_add_event()

xroad_errno_t xroad_time_list_add_event	(	xroad_time_list_t *	tlist,
		xroad_time_t	event_time,
		xroad_str_t	event_name,
		xroad_time_list_callback_t	cback
	)

add time event to list. Combination of time+name is a event key

Parameters

[in]	tlist	- time list to add event
[in]	event_time	- time when event must be fired
[in]	event_name	- time event name
[in]	cback	- event callback

Returns

XROAD_OK - added, XROAD_ERROR_ALREADY_EXISTS - such event alredy exists XROAD_ERROR_ALREADY_DONE - event time in past, so will never fired

xroad_time_list_clear()

void xroad_time_list_clear

(

xroad_time_list_t *

tlist

)

clear all time table events

Parameters

[in[	tlist - time list to clear

xroad_time_list_create()

xroad_time_list_t* xroad_time_list_create

(

)

create new time list

Returns

time list instance

xroad_time_list_del_event()

xroad_errno_t xroad_time_list_del_event	(	xroad_time_list_t *	tlist,
		xroad_time_t	event_time,
		xroad_str_t	event_name
	)

delete event by key time+name

Parameters

[in]	tlist	- time list
[in]	event_time	- event time
	[in[	event_name - event name

Returns

XROAD_OK - deleted, XROAD_ERROR_NOT_FOUND - event not found

xroad_time_list_destroy()

void xroad_time_list_destroy

(

xroad_time_list_t *

tlist

)

destroy time list

Parameters

[in]

tlist

- time list to destroy