poll.c

Cross-platform polling library for C
git clone git://git.finwo.net/lib/poll.c
Log | Files | Refs | README

README.md (1013B)


      1 finwo/poll
      2 ==========
      3 
      4 Basic cross-platform io multiplexing library, focussing on polling
      5 
      6 ## Why
      7 
      8 Yes, there's already modern replacements for [poll(2)][poll2] and
      9 [select(2)][select2], and things like libevent, that handle io multiplexing
     10 properly, but none that I could find that were easily embeddable without having
     11 the resulting binary depend on those libraries.
     12 
     13 While initially an easy-to-use wrapper around poll(2), platform-specific
     14 optimizations (like using epoll/kqueue) will be implemented here without the
     15 external api changing to allow all my projects to benefit from the work here.
     16 
     17 ## Installation
     18 
     19 This library is intended to be installed through
     20 [dep](https://github.com/finwo/dep), but can be embedded by dropping in the
     21 [fpoll.c](src/fpoll.c) and [fpoll.h](src/fpoll.h) files into your project and
     22 including them during compilation.
     23 
     24 ```
     25 dep add finwo/poll
     26 ```
     27 
     28 ## API
     29 
     30 [poll2]: https://man7.org/linux/man-pages/man2/poll.2.html
     31 [select2]: https://man7.org/linux/man-pages/man2/select.2.html