Add module descriptions for the driver implementations.

This commit is contained in:
Sönke Ludwig 2016-01-16 16:33:20 +01:00
parent b92be4a29d
commit 8212d9e16a
4 changed files with 21 additions and 0 deletions

View file

@ -1,3 +1,9 @@
/**
Linux epoll based event driver implementation.
Epoll is an efficient API for asynchronous I/O on Linux, suitable for large
numbers of concurrently open sockets.
*/
module eventcore.drivers.epoll; module eventcore.drivers.epoll;
@safe: /*@nogc:*/ nothrow: @safe: /*@nogc:*/ nothrow:

View file

@ -1,3 +1,8 @@
/**
Base class for BSD socket based driver implementations.
See_also: `eventcore.drivers.select`, `eventcore.drivers.epoll`
*/
module eventcore.drivers.posix; module eventcore.drivers.posix;
@safe: /*@nogc:*/ nothrow: @safe: /*@nogc:*/ nothrow:

View file

@ -1,3 +1,10 @@
/**
A `select` based event driver implementation.
This driver works on all BSD socket compatible operating systems, including
Windows. It has a good performance for small numbers of cuncurrently open
files/sockets, but is not suited for larger amounts.
*/
module eventcore.drivers.select; module eventcore.drivers.select;
@safe: /*@nogc:*/ nothrow: @safe: /*@nogc:*/ nothrow:

View file

@ -1,3 +1,6 @@
/**
Efficient generic management of large numbers of timers.
*/
module eventcore.drivers.timer; module eventcore.drivers.timer;
import eventcore.driver; import eventcore.driver;