/* libuev - Asynchronous event loop library
 *
 * Copyright (c) 2012  Flemming Madsen <flemming!madsen()madsensoft!dk>
 * Copyright (c) 2013  Joachim Nilsson <troglobit()gmail!com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef LIBUEV_H_
#define LIBUEV_H_

#include "llist.h"

struct uev;
struct uev_io;
struct uev_timer;

/* I/O direction */
typedef enum {
	UEV_FHIN = 0,
	UEV_FHOUT = 1
} uev_dir_t;

/* I/O event type */
typedef struct uev_io_rem {
	LListField(struct uev_io_rem);
	struct uev_io *ent;
} uev_io_rem_t;

typedef struct uev_io {
	LListField(struct uev_io);      ///< Elements for linked list
	uev_io_rem_t   rem;             ///< For postponed removal

	int            fd;              ///< File descriptor
	uev_dir_t      dir;             ///< Direction: in or out
	int            index;           ///< Index in poll array

	int          (*handler)(struct uev *, struct uev_io *, int, void *);
	void          *data;            ///< Callback optional parameter
} uev_io_t;

/* Timer event type */
typedef struct uev_timer {
	LListField(struct uev_timer);   ///< Linked list elements

	int            due;             ///< Epoch timestamp

	int          (*handler)(struct uev *, struct uev_timer *, void *);
	void          *data;            ///< Timer callback parameter
} uev_timer_t;

/**
 * @cond doxygen does not like this construction
 */
typedef LList(uev_timer_t)  uev_timer_list_t;
typedef LList(uev_io_t)     uev_io_list_t;
typedef LList(uev_io_rem_t) uev_io_rem_list_t;
/**
 * @endcond
 */

/* Main libuev context type */
typedef struct {
	uev_io_list_t     io_list;      ///< File handlers
	uev_timer_list_t  timer_list;   ///< Timer handlers

	uev_io_rem_list_t io_delist;    ///< List of file handles to be garbage collected
	uev_timer_list_t  timer_delist; ///< List of timer handles to be garbage collected

	clock_t           base_time;    ///< Time at last timer tick
	clock_t           next_time;    ///< Next timer tick epoch
	int               use_next;     ///< True if next timer epoch is set

	int               exiting;      ///< True if the application is terminating
} uev_t;

/* Callbacks for different watchers */
typedef int (*uev_io_cb_t)   (uev_t *ctx, uev_io_t    *w, int fd, void *data);
typedef int (*uev_timer_cb_t)(uev_t *ctx, uev_timer_t *w,         void *data);

/* Public interface */
uev_io_t    *uev_io_create    (uev_t *ctx, int fd, uev_dir_t dir, uev_io_cb_t handler, void *data);
int          uev_io_delete    (uev_t *ctx, uev_io_t *io);

uev_timer_t *uev_timer_create (uev_t *ctx, int msec, uev_timer_cb_t handler, void *data);
int          uev_timer_delete (uev_t *ctx, uev_timer_t *hdl);

uev_t       *uev_create       (void);
void         uev_delete       (uev_t *uev);

void         uev_run_tick     (uev_t *ctx, int msec);
int          uev_run_pending  (uev_t *ctx);

void         uev_run          (uev_t *ctx);
void         uev_exit         (uev_t *ctx);

#endif /* LIBUEV_H_ */

/**
 * Local Variables:
 *  version-control: t
 *  indent-tabs-mode: t
 *  c-file-style: "linux"
 * End:
 */