diff --git a/source/eventcore/drivers/epoll.d b/source/eventcore/drivers/epoll.d index 9c390e1..94f2507 100644 --- a/source/eventcore/drivers/epoll.d +++ b/source/eventcore/drivers/epoll.d @@ -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; @safe: /*@nogc:*/ nothrow: diff --git a/source/eventcore/drivers/posix.d b/source/eventcore/drivers/posix.d index 3aa1fd7..f6562cc 100644 --- a/source/eventcore/drivers/posix.d +++ b/source/eventcore/drivers/posix.d @@ -1,3 +1,8 @@ +/** + Base class for BSD socket based driver implementations. + + See_also: `eventcore.drivers.select`, `eventcore.drivers.epoll` +*/ module eventcore.drivers.posix; @safe: /*@nogc:*/ nothrow: diff --git a/source/eventcore/drivers/select.d b/source/eventcore/drivers/select.d index fea136a..8d6d64c 100644 --- a/source/eventcore/drivers/select.d +++ b/source/eventcore/drivers/select.d @@ -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; @safe: /*@nogc:*/ nothrow: diff --git a/source/eventcore/drivers/timer.d b/source/eventcore/drivers/timer.d index 2a853e7..a7c1333 100644 --- a/source/eventcore/drivers/timer.d +++ b/source/eventcore/drivers/timer.d @@ -1,3 +1,6 @@ +/** + Efficient generic management of large numbers of timers. +*/ module eventcore.drivers.timer; import eventcore.driver;