mainloop-api.h

Go to the documentation of this file.

#ifndef foomainloopapihfoo
#define foomainloopapihfoo

/***
  This file is part of PulseAudio.

  Copyright 2004-2006 Lennart Poettering
  Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB

  PulseAudio is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) any later version.

  PulseAudio is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with PulseAudio; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  USA.
***/

#include <sys/time.h>
#include <time.h>

#include <pulse/cdecl.h>
#include <pulse/sample.h>
#include <pulse/version.h>

PA_C_DECL_BEGIN

typedef struct pa_mainloop_api pa_mainloop_api;

typedef enum pa_io_event_flags {
    PA_IO_EVENT_NULL = 0,     
    PA_IO_EVENT_INPUT = 1,    
    PA_IO_EVENT_OUTPUT = 2,   
    PA_IO_EVENT_HANGUP = 4,   
    PA_IO_EVENT_ERROR = 8     
} pa_io_event_flags_t;

typedef struct pa_io_event pa_io_event;
typedef void (*pa_io_event_cb_t)(pa_mainloop_api*ea, pa_io_event* e, int fd, pa_io_event_flags_t events, void *userdata);
typedef void (*pa_io_event_destroy_cb_t)(pa_mainloop_api*a, pa_io_event *e, void *userdata);

typedef struct pa_time_event pa_time_event;
typedef void (*pa_time_event_cb_t)(pa_mainloop_api*a, pa_time_event* e, const struct timeval *tv, void *userdata);
typedef void (*pa_time_event_destroy_cb_t)(pa_mainloop_api*a, pa_time_event *e, void *userdata);

typedef struct pa_defer_event pa_defer_event;
typedef void (*pa_defer_event_cb_t)(pa_mainloop_api*a, pa_defer_event* e, void *userdata);
typedef void (*pa_defer_event_destroy_cb_t)(pa_mainloop_api*a, pa_defer_event *e, void *userdata);

struct pa_mainloop_api  {
    void *userdata;

    pa_io_event* (*io_new)(pa_mainloop_api*a, int fd, pa_io_event_flags_t events, pa_io_event_cb_t cb, void *userdata);
    void (*io_enable)(pa_io_event* e, pa_io_event_flags_t events);
    void (*io_free)(pa_io_event* e);
    void (*io_set_destroy)(pa_io_event *e, pa_io_event_destroy_cb_t cb);

    pa_time_event* (*time_new)(pa_mainloop_api*a, const struct timeval *tv, pa_time_event_cb_t cb, void *userdata);
    void (*time_restart)(pa_time_event* e, const struct timeval *tv);
    void (*time_free)(pa_time_event* e);
    void (*time_set_destroy)(pa_time_event *e, pa_time_event_destroy_cb_t cb);

    pa_defer_event* (*defer_new)(pa_mainloop_api*a, pa_defer_event_cb_t cb, void *userdata);
    void (*defer_enable)(pa_defer_event* e, int b);
    void (*defer_free)(pa_defer_event* e);
    void (*defer_set_destroy)(pa_defer_event *e, pa_defer_event_destroy_cb_t cb);

    void (*quit)(pa_mainloop_api*a, int retval);
};

void pa_mainloop_api_once(pa_mainloop_api*m, void (*callback)(pa_mainloop_api*m, void *userdata), void *userdata);

PA_C_DECL_END

#endif