From d2ed70b6ddc2ed0d58f7b96ec1fdc8d66be8928b Mon Sep 17 00:00:00 2001 From: Pedro Pinto Date: Fri, 8 Jan 2021 10:36:24 -0500 Subject: [PATCH] Added a few comments. --- .../cmds/spartan/system/reactor/IReactorConnection.h | 4 ++++ .../sparkd/cmds/spartan/system/reactor/IReactorHandler.h | 8 ++++++++ 2 files changed, 12 insertions(+) diff --git a/src/server/sparkd/cmds/spartan/system/reactor/IReactorConnection.h b/src/server/sparkd/cmds/spartan/system/reactor/IReactorConnection.h index 51fcea080..d548b831b 100644 --- a/src/server/sparkd/cmds/spartan/system/reactor/IReactorConnection.h +++ b/src/server/sparkd/cmds/spartan/system/reactor/IReactorConnection.h @@ -2,6 +2,10 @@ namespace bts::spartan { +// UDP or TCP connection handle for a connection managed by a +// reactor. Connections are obtained via +// Reactor::register_connection(). A connection is initially inactive +// and must be activated via the connect() call. class IReactorConnection { public: virtual ~IReactorConnection() {} diff --git a/src/server/sparkd/cmds/spartan/system/reactor/IReactorHandler.h b/src/server/sparkd/cmds/spartan/system/reactor/IReactorHandler.h index fd8cb485a..51db0b616 100644 --- a/src/server/sparkd/cmds/spartan/system/reactor/IReactorHandler.h +++ b/src/server/sparkd/cmds/spartan/system/reactor/IReactorHandler.h @@ -6,8 +6,16 @@ namespace bts::spartan { class IReactorHandler { public: virtual ~IReactorHandler() {}; + + // Succesfull connection virtual void on_connect() = 0; + + // Disconnection after successfull connection or failure to connect virtual void on_disconnect() = 0; + + // Successfull read. Passed buffer will be dealocated once the call + // return. Callers should copy it or complete processing it before + // returning. virtual void on_data(const std::string_view &buffer) = 0; };