source/proj/ev.d/index.rst

   1
   2 ====
   3 ev.d
   4 ====
   5
   6 .. highlight:: d
   7
   8
   9 Introduction
  10 ============
  11
  12
  13 **ev.d** is both a low and high level libev_  bindings for the `D Programming
  14 Language`_ .
  15
  16 All modules are placed in the ``ev`` package.
  17
  18 .. note::
  19
  20    libev_ should be compiled with ``EV_MULTIPLICITY=1`` to work with **ev.d**.
  21
  22
  23
  24 Low level API (``ev.c``)
  25 ========================
  26
  27 The low level bindings directly expose the C API, without any specific D magic.
  28 You can almost port a simple C libev example changing a few lines of code, for
  29 example::
  30
  31    import ev.c;
  32    // ....
  33    void main()
  34    {
  35            ev_io stdin_watcher;
  36            auto loop = ev_default_loop();
  37            /* initialise an io watcher, then start it */
  38            ev_io_init(&stdin_watcher, &stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
  39            ev_io_start(loop, &stdin_watcher);
  40            /* loop till timeout or data ready */
  41            ev_loop(loop, 0);
  42    }
  43
  44 For a complete example see `ctest.d`__.
  45
  46 __ https://git.llucax.com/w/software/ev.d.git/blob/HEAD:/ctest.d
  47
  48
  49
  50 High level API (``ev.d``)
  51 =========================
  52
  53 The high level API adds some D sugar on top of the low level API, providing
  54 a more D-ish experience.
  55
  56 You can use delegates to handle events and is a little more object oriented.
  57
  58 Here is a very simple example::
  59
  60    import std.stdio;
  61    import ev.d;
  62
  63    void main()
  64    {
  65            (new Timer(5.5,
  66                    (Timer w, int revents)
  67                    {
  68                            writefln("timeout, revents = ", revents);
  69                            w.loop.unloop(Unloop.ONE); // example syntax
  70                    }
  71            )).start;
  72            loop.loop;
  73    }
  74
  75 For a complete example see `dtest.d`__.
  76
  77 __ https://git.llucax.com/w/software/ev.d.git/blob/HEAD:/dtest.d
  78
  79
  80
  81 Compile-time options
  82 ====================
  83
  84 You can disable specific watchers types at compile-time (this should be in
  85 sync with libev watchers support).
  86
  87 To do that, use version ``EV_ENABLE_SELECT`` and then select the specific
  88 watchers you want to enable.
  89
  90 For example: ``gdc -fversion=EV_ENABLE_SELECT -fversion=EV_STAT_ENABLE`` to
  91 enable only the ``ev_stat`` extra watcher.
  92
  93
  94
  95 Download
  96 ========
  97
  98 There are no proper releases yet, but mainly because the code is so simple,
  99 not because the code is not working or stable enough. You can get the code
 100 from the Git_ repository__ (you can get a tarball there too, if you don't have
 101 Git_ installed).
 102
 103 __ https://git.llucax.com/w/software/ev.d.git
 104
 105
 106
 107 Support
 108 =======
 109
 110 If you have any problems/comments/suggestions, you can contact me directly at
 111 luca@llucax.com.  If at any time there is enough people interested in
 112 **ev.d** I might open a mailing list for it, but for now it seems overkill to
 113 do so =).
 114
 115
 116
 117 Author
 118 ======
 119
 120 **ev.d** was written by Leandro Lucarella.
 121
 122
 123
 124 License
 125 =======
 126
 127 **ev.d** is placed under the BOLA_ License which is basically Public Domain.
 128
 129
 130 .. _libev: http://software.schmorp.de/pkg/libev.html
 131 .. _`D Programming Language`: http://www.digitalmars.com/d/
 132 .. _BOLA: http://auriga.wearlab.de/~alb/bola/
 133 .. _Git: http://git.or.cz/
 134
 135 .. vim: set et sw=3 sts=3 tw=78 :