Document Timeout

Author: Al2Klimov

lib/base/io-engine.cpp

@@ -146,6 +146,9 @@ void AsioConditionVariable::Wait(boost::asio::yield_context yc)
 	m_Timer.async_wait(yc[ec]);
 }
 
+/**
+ * Unschedules any callback scheduled by the constructor, unless it has already been run.
+ */
 void Timeout::Cancel()
 {
 	boost::system::error_code ec;

lib/base/io-engine.hpp

@@ -174,6 +174,9 @@ class Timeout : public SharedObject
 public:
 	DECLARE_PTR_TYPEDEFS(Timeout);
 
+	/**
+	 * Schedules onTimeout to be run after timeoutFromNow on strand.
+	 */
 	template<class OnTimeout>
 	Timeout(boost::asio::io_context::strand& strand, const decltype(m_Timer)::duration_type& timeoutFromNow, OnTimeout onTimeout)
 		: m_Timer(strand.context(), timeoutFromNow)
@@ -187,6 +190,11 @@ class Timeout : public SharedObject
 		}));
 	}
 
+	/**
+	 * Unschedules any callback scheduled by the constructor, unless it has already been run.
+	 */
+	~Timeout() override = default;
+
 	void Cancel();
 };