iv_task(3) [debian man page]

iv_task(3)						    ivykis programmer's manual							iv_task(3)

NAME

       iv_task_register, iv_task_unregister, iv_task_registered - deal with ivykis tasks

SYNOPSIS

       #include <iv.h>

       struct iv_task {
	       void	       *cookie;
	       void	       (*handler)(void *);
       };

       void IV_TASK_INIT(struct iv_task *task);
       void iv_task_register(struct iv_task *task);
       void iv_task_unregister(struct iv_task *task);
       int iv_task_registered(struct iv_task *task);

DESCRIPTION

       The  functions  iv_task_register  and  iv_task_unregister  register, respectively unregister, a task with the current thread's ivykis event
       loop.  iv_task_registered on a task returns true if that task is currently registered with ivykis.

       A task is like a timer, but with an immediate timeout.  When a task is registered, unless it is	unregistered  again  first,  the  callback
       function  specified  by	->handler  is guaranteed to be called once, in the thread that the task was registered in, some time after control
       returns to the ivykis main loop but before ivykis will sleep for more events, with ->cookie as its first and sole argument.  When this hap-
       pens, the task is transparently unregistered.

       Tasks  are  mainly used for scheduling code for execution where it is not appropriate to directly run that code in the calling context (for
       example, because the current context might be run as a callback function where the caller expects certain conditions  to  remain  invariant
       after the callback completes).

       The application is allowed to change the ->cookie and ->handler members at any time.

       A given struct iv_task can only be registered in one thread at a time, and a task can only be unregistered in the thread that it was regis-
       tered from.

       There is no limit on the number of tasks registered at once.

       See iv_examples(3) for programming examples.

SEE ALSO

       ivykis(3), iv_examples(3)

ivykis								    2010-08-15								iv_task(3)

iv_event(3)						    ivykis programmer's manual						       iv_event(3)

NAME

       IV_EVENT_INIT, iv_event_register, iv_event_unregister, iv_event_post - manage ivykis objects for event notification

SYNOPSIS

       #include <iv_event.h>

       struct iv_event {
	       void	       *cookie;
	       void	       (*handler)(void *);
       };

       int IV_EVENT_INIT(struct iv_event *this);
       int iv_event_register(struct iv_event *this);
       void iv_event_unregister(struct iv_event *this);
       void iv_event_post(struct iv_event *this);

DESCRIPTION

       iv_event provides a way for delivering events to ivykis(3) recipients across thread boundaries.

       The intended event recipient calls IV_EVENT_INIT on a struct iv_event object, fills in ->cookie and ->handler, and then calls iv_event_reg-
       ister on the object.

       To generate an event, call iv_event_post on the previously initialized struct iv_event object.  This will cause the callback  specified	by
       ->handler to be called in the thread that the struct iv_event object was registered in, with ->cookie as its sole argument.

       To  deinitialize  a  struct  iv_event  object, call iv_event_unregister from the same thread that iv_event_register was called from on that
       object.

       It is permitted to unregister a struct iv_event object from any ivykis callback function in the thread it was registered in, including from
       a  callback  function triggered by this object, and it is permitted to free the memory corresponding to an unregistered object from its own
       callback function.

       iv_event_post can be called from the same thread that iv_event_register was called from,  or  from  a  different  thread  within  the  same
       process,  but can not be called from a different process, and can not be called from signal handlers.  If you need this functionality, look
       at iv_event_raw(3).

       Internally, iv_event is implemented as a wrapper around iv_event_raw(3), and multiplexes multiple struct iv_event objects  over	per-thread
       struct iv_event_raw objects, to save file descriptors and kernel resources.

SEE ALSO

       ivykis(3), iv_event_raw(3)

ivykis								    2010-09-03							       iv_event(3)