summaryrefslogtreecommitdiff
path: root/src/libaudcore/mainloop.h
blob: dabf9e3d517bb332eff80815cccae1eec56898e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
/*
 * mainloop.h
 * Copyright 2014 John Lindgren
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions, and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions, and the following disclaimer in the documentation
 *    provided with the distribution.
 *
 * This software is provided "as is" and without any warranty, express or
 * implied. In no event shall the authors be liable for any damages arising from
 * the use of this software.
 */

/* Main loop abstraction layer which can use either GLib or Qt as a backend.
 * The API is completely thread-safe and can thus be used as a means to call
 * back into the main thread from a worker thread. */

#ifndef LIBAUDCORE_MAINLOOP_H
#define LIBAUDCORE_MAINLOOP_H

struct QueuedFuncHelper;
struct QueuedFuncParams;

class QueuedFunc
{
    friend struct QueuedFuncHelper;

public:
    typedef void (* Func) (void * data);

    // one-time idle callback
    void queue (Func func, void * data);

    // one-time delayed callback
    void queue (int delay_ms, Func func, void * data);

    // periodic timer callback
    void start (int interval_ms, Func func, void * data);

    // stops any type of callback
    // note that queue() and start() also stop any previous callback
    void stop ();

    // true if a periodic timer is running
    // does not apply to one-time callbacks
    bool running () const
        { return _running; }

    constexpr QueuedFunc () = default;
    QueuedFunc (const QueuedFunc &) = delete;
    void operator= (const QueuedFunc &) = delete;

    ~QueuedFunc ()
        { stop (); }

private:
    bool _running = false;

    void start (const QueuedFuncParams & params);
};

void mainloop_run ();
void mainloop_quit ();

#endif // LIBAUDCORE_MAINLOOP_H