From 8f358c92ca7303d9bbc3d67056e632eedeaee37a Mon Sep 17 00:00:00 2001 From: Ryan Burn Date: Sun, 10 May 2020 17:41:04 -0700 Subject: [PATCH] Add commenting --- sdk/src/event/libevent/io_dispatcher.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/sdk/src/event/libevent/io_dispatcher.h b/sdk/src/event/libevent/io_dispatcher.h index c20f636150..b92be1e6e5 100644 --- a/sdk/src/event/libevent/io_dispatcher.h +++ b/sdk/src/event/libevent/io_dispatcher.h @@ -12,6 +12,13 @@ namespace event { namespace libevent { +/** + * Manages asynchronous events on a file descriptor. + * + * IoDispatcher enables an efficient design where SDKs use non-blocking sockets and a single + * background thread manages events by making successive calls to the OS's IO multiplexing polling + * function. + */ class IoDispatcher final : public event::IoDispatcher { public: