coffee/continuable
1
0
Fork 0
mirror of https://github.com/Naios/continuable.git synced 2025-12-06 16:56:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Adds documentation entries for the destructor and release method.

Browse Source
This commit is contained in:
Denis Blank 2017-02-27 00:58:44 +01:00
parent 7ae1aedfbb
commit 4448eb7351
2 changed files with 28 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/Index.md
View File

@ -5,11 +5,12 @@ This documentation covers the continuable library in detail
## Content
- Class cti::continuable_base - main class for continuation chaining
- \link cti::continuable_base::then then\endlink - adds a callback to the chain
- \link cti::continuable_base::operator && operator&&\endlink - connects another continuable with an *all* logic.
- \link cti::continuable_base::operator|| operator||\endlink - connects another continuable with an *any* logic.
- \link cti::continuable_base::then then\endlink - adds a callback or cti::continuable_base to the invocation chain.
- \link cti::continuable_base::operator && operator&&\endlink - connects another cti::continuable_base with an *all* logic.
- \link cti::continuable_base::operator|| operator||\endlink - connects another cti::continuable_base with an *any* logic.
- \link cti::continuable_base::release release\endlink - releases the cti::continuable_base and prevents the automatic invocation on destruction.
- Helper functions
- \link cti::make_continuable make_continuable\endlink - creates a continuable_base from a callback tanking function.
- \link cti::all_of all_of\endlink - connects all given continuables with an *all* logic.
- \link cti::any_of any_of\endlink - connects all given continuables with an *any* logic.
- \link cti::make_continuable make_continuable\endlink - creates a cti::continuable_base from a callback tanking function.
- \link cti::all_of all_of\endlink - connects all given cti::continuable_base objects with an *all* logic.
- \link cti::any_of any_of\endlink - connects all given cti::continuable_base objects with an *any* logic.

28
include/continuable/continuable-base.hpp
View File

@ -37,6 +37,7 @@ namespace cti {
/// \cond false
inline namespace abi_v1 {
/// \endcond
/// A wrapper class to mark a functional class as continuation
/// Such a wrapper class is required to decorate the result of a callback
/// correctly.
@ -1251,12 +1252,23 @@ public:
continuable_base(continuable_base<OData, OAnnotation>&& other)
: continuable_base(std::move(other).materialize().consumeData()) {}
/// \cond false
continuable_base(continuable_base&&) = default;
continuable_base(continuable_base const&) = default;
continuable_base& operator=(continuable_base&&) = default;
continuable_base& operator=(continuable_base const&) = default;
/// \endcond
/// The destructor automatically invokes the continuable_base
/// if it wasn't consumed yet.
///
/// In order to invoke the continuable early you may call the
/// continuable_base::done() method.
///
/// You may release the continuable_base through calling the corresponding
/// continuable_base::release() method which prevents
/// the invocation on destruction.
~continuable_base() {
if (ownership_.has_ownership()) {
std::move(*this).done();
@ -1301,6 +1313,8 @@ public:
assert(!ownership_.has_ownership());
}
/// Prevents the automatic invocation on destruction as explained
/// in continuable_base::~continuable_base().
void release() noexcept { ownership_.invalidate(); }
private:
@ -1336,7 +1350,7 @@ private:
}
};
/// Creates a \ref continuable_base from a callback taking function.
/// Creates a continuable_base from a callback taking function.
///
/// \tparam Args The types (signature hint) the given callback is called with.
/// * **Some arguments** indicate the types the callback will be invoked with.
@ -1405,9 +1419,9 @@ private:
/// });
/// ```
///
/// \returns A \ref continuable_base with unknown template parameters which
/// \returns A continuable_base with unknown template parameters which
/// wraps the given continuation.
/// In order to convert the \ref continuable_base to a known type
/// In order to convert the continuable_base to a known type
/// you need to apply type erasure.
///
/// \note You should always turn the callback into a r-value if possible
@ -1426,10 +1440,10 @@ auto make_continuable(Continuation&& continuation) {
/// Connects the given continuables with an *all* logic.
///
/// \param continuables The \ref continuable_base objects to connect.
/// \param continuables The continuable_base objects to connect.
/// Requires at least 2 objects to connect.
///
/// \see \ref continuable_base::operator && for details.
/// \see continuable_base::operator && for details.
///
/// \since version 1.0.0
template <typename... Continuables>
@ -1442,10 +1456,10 @@ auto all_of(Continuables&&... continuables) {
/// Connects the given continuables with an *any* logic.
///
/// \param continuables The \ref continuable_base objects to connect.
/// \param continuables The continuable_base objects to connect.
/// Requires at least 2 objects to connect.
///
/// \see \ref continuable_base::operator|| for details.
/// \see continuable_base::operator|| for details.
///
/// \since version 1.0.0
template <typename... Continuables>