eventcore/README.md

EventCore
=========

This is a high-performance native event loop abstraction for D, focused on asynchronous I/O and GUI message integration. The API is callback (delegate) based. For a higher level fiber based abstraction, take a look at [vibe.d](https://vibed.org/).

[![DUB Package](https://img.shields.io/dub/v/eventcore.svg)](https://code.dlang.org/packages/eventcore)
[![Posix Build Status](https://travis-ci.org/vibe-d/eventcore.svg?branch=master)](https://travis-ci.org/vibe-d/eventcore)
[![Windows Build Status](https://ci.appveyor.com/api/projects/status/1a9r8sypyy9fq2j8/branch/master?svg=true)](https://ci.appveyor.com/project/s-ludwig/eventcore)


Supported drivers and operating systems
---------------------------------------

Driver               | Linux   | Windows | macOS   | FreeBSD | Android | iOS
---------------------|---------|---------|---------|---------|---------|---------
SelectEventDriver    | yes     | yes     | yes     | yes¹    | &mdash; | &mdash;
EpollEventDriver     | yes     | &mdash; | &mdash; | &mdash; | &mdash; | &mdash;
WinAPIEventDriver    | &mdash; | yes     | &mdash; | &mdash; | &mdash; | &mdash;
KqueueEventDriver    | &mdash; | &mdash; | yes     | yes¹    | &mdash; | &mdash;
LibasyncEventDriver  | &mdash;¹| &mdash;¹| &mdash;¹| &mdash;¹| &mdash; | &mdash;

¹ planned, but not currenly implemented


Supported compilers
-------------------

The following compilers are tested and supported:

- DMD 2.073.0
- DMD 2.072.2
- DMD 2.071.2
- DMD 2.070.2
- LDC 1.1.0
- LDC 1.0.0


Driver development status
-------------------------

Feature          | SelectEventDriver | EpollEventDriver | WinAPIEventDriver | KqueueEventDriver
-----------------|-------------------|------------------|-------------------|------------------
TCP Sockets      | yes               | yes              | yes               | yes              
UDP Sockets      | yes               | yes              | &mdash;           | yes              
USDS             | yes               | yes              | &mdash;           | yes              
DNS              | yes               | yes              | yes               | yes              
Timers           | yes               | yes              | yes               | yes              
Events           | yes               | yes              | yes               | yes              
Unix Signals     | yes²              | yes              | &mdash;           | &mdash;          
Files            | yes               | yes              | yes               | yes              
UI Integration   | yes¹              | yes¹             | yes               | yes¹             
File watcher     | yes²              | yes              | yes               | &mdash;          

Feature          | LibasyncEventDriver 
-----------------|---------------------
TCP Sockets      | &mdash;             
UDP Sockets      | &mdash;             
USDS             | &mdash;             
DNS              | &mdash;             
Timers           | &mdash;             
Events           | &mdash;             
Unix Signals     | &mdash;             
Files            | &mdash;             
UI Integration   | &mdash;             
File watcher     | &mdash;             

¹ Manually, by adopting the X11 display connection socket

² Currently only supported on Linux


### Open questions

- Error code reporting
- Enqueued writes
- Use the type system to prohibit passing thread-local handles to foreign threads
Add README.md. 2016-01-16 14:47:27 +00:00			`EventCore`
			`=========`

			`This is a high-performance native event loop abstraction for D, focused on asynchronous I/O and GUI message integration. The API is callback (delegate) based. For a higher level fiber based abstraction, take a look at [vibe.d](https://vibed.org/).`

Add DUB and AppVeyor badges. 2017-01-23 08:06:28 +00:00			`[![DUB Package](https://img.shields.io/dub/v/eventcore.svg)](https://code.dlang.org/packages/eventcore)`
			`[![Posix Build Status](https://travis-ci.org/vibe-d/eventcore.svg?branch=master)](https://travis-ci.org/vibe-d/eventcore)`
			`[![Windows Build Status](https://ci.appveyor.com/api/projects/status/1a9r8sypyy9fq2j8/branch/master?svg=true)](https://ci.appveyor.com/project/s-ludwig/eventcore)`
Add build badge to readme. 2016-06-18 05:32:17 +00:00
Add README.md. 2016-01-16 14:47:27 +00:00
			`Supported drivers and operating systems`
			`---------------------------------------`

Add more drivers/operating systems to the support matrix. 2017-01-22 10:46:48 +00:00			`Driver \| Linux \| Windows \| macOS \| FreeBSD \| Android \| iOS`
			`---------------------\|---------\|---------\|---------\|---------\|---------\|---------`
Update development status. 2017-01-25 15:14:42 +00:00			`SelectEventDriver \| yes \| yes \| yes \| yes¹ \| — \| —`
Add more drivers/operating systems to the support matrix. 2017-01-22 10:46:48 +00:00			`EpollEventDriver \| yes \| — \| — \| — \| — \| —`
			`WinAPIEventDriver \| — \| yes \| — \| — \| — \| —`
Update development status. 2017-01-25 15:14:42 +00:00			`KqueueEventDriver \| — \| — \| yes \| yes¹ \| — \| —`
Fix some errors in README. 2017-01-22 20:01:13 +00:00			`LibasyncEventDriver \| —¹\| —¹\| —¹\| —¹\| — \| —`
Update README.md. 2016-06-24 12:22:08 +00:00
			`¹ planned, but not currenly implemented`
Add README.md. 2016-01-16 14:47:27 +00:00

Test with LDC 1.1.0 final and add compiler support list to README. 2017-02-01 11:15:58 +00:00			`Supported compilers`
			`-------------------`

			`The following compilers are tested and supported:`

			`- DMD 2.073.0`
			`- DMD 2.072.2`
			`- DMD 2.071.2`
			`- DMD 2.070.2`
			`- LDC 1.1.0`
			`- LDC 1.0.0`


Add README.md. 2016-01-16 14:47:27 +00:00			`Driver development status`
			`-------------------------`

Fix Windows driver name in README. 2016-10-19 12:29:18 +00:00			`Feature \| SelectEventDriver \| EpollEventDriver \| WinAPIEventDriver \| KqueueEventDriver`
			`-----------------\|-------------------\|------------------\|-------------------\|------------------`
Mention Windows TCP support in README.md. 2017-06-24 20:18:18 +00:00			`TCP Sockets \| yes \| yes \| yes \| yes`
Update README with kqueue features. 2017-01-22 19:55:16 +00:00			`UDP Sockets \| yes \| yes \| — \| yes`
			`USDS \| yes \| yes \| — \| yes`
Implement simple (synchronous) DNS lookup for the WinAPI driver. 2017-01-23 20:37:35 +00:00			`DNS \| yes \| yes \| yes \| yes`
Update README with kqueue features. 2017-01-22 19:55:16 +00:00			`Timers \| yes \| yes \| yes \| yes`
			`Events \| yes \| yes \| yes \| yes`
Mention Windows TCP support in README.md. 2017-06-24 20:18:18 +00:00			`Unix Signals \| yes² \| yes \| — \| —`
Update README with kqueue features. 2017-01-22 19:55:16 +00:00			`Files \| yes \| yes \| yes \| yes`
Fix some errors in README. 2017-01-22 20:01:13 +00:00			`UI Integration \| yes¹ \| yes¹ \| yes \| yes¹`
Mention Windows TCP support in README.md. 2017-06-24 20:18:18 +00:00			`File watcher \| yes² \| yes \| yes \| —`
Add some remaining TODOs to the README. 2016-10-07 17:40:18 +00:00
Add more drivers/operating systems to the support matrix. 2017-01-22 10:46:48 +00:00			`Feature \| LibasyncEventDriver`
			`-----------------\|---------------------`
			`TCP Sockets \| —`
			`UDP Sockets \| —`
			`USDS \| —`
			`DNS \| —`
			`Timers \| —`
			`Events \| —`
			`Unix Signals \| —`
			`Files \| —`
			`UI Integration \| —`
			`File watcher \| —`

Implement socket adoption and fix wait loops on Windows for the Posix driver. 2017-01-22 09:43:18 +00:00			`¹ Manually, by adopting the X11 display connection socket`
Fix some errors in README. 2017-01-22 20:01:13 +00:00
Implement listening for signals based on signalfd(). 2016-10-16 19:06:11 +00:00			`² Currently only supported on Linux`

Add getaddrinfo based DNS lookup implementation. 2016-10-16 12:30:52 +00:00
Add another TODO item to the development state. 2017-01-22 10:39:41 +00:00			`### Open questions`
Add some remaining TODOs to the README. 2016-10-07 17:40:18 +00:00
			`- Error code reporting`
			`- Enqueued writes`
Add another TODO item to the development state. 2017-01-22 10:39:41 +00:00			`- Use the type system to prohibit passing thread-local handles to foreign threads`