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

Move the slideshow code to examples

Browse Source 
* Remove the rest from doc
This commit is contained in:
Denis Blank 2018-03-12 07:07:30 +01:00
parent b5571c5ee1
commit 9f881f83f0
9 changed files with 18 additions and 199 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CMakeLists.txt
View File

@ -130,8 +130,6 @@ if (CTI_CONTINUABLE_WITH_TESTS OR CTI_CONTINUABLE_WITH_EXAMPLES)
enable_testing()
add_subdirectory(doc)
if (CTI_CONTINUABLE_WITH_TESTS)
add_subdirectory(test)
endif()

1
doc/CMakeLists.txt
View File

@ -1 +0,0 @@
add_subdirectory(code)

2
doc/code/CMakeLists.txt
View File

@ -1,2 +0,0 @@
add_subdirectory(documentation)
add_subdirectory(slideshow)

5
doc/code/documentation/CMakeLists.txt
View File

@ -1,5 +0,0 @@
add_executable(doc-documentation
${CMAKE_CURRENT_LIST_DIR}/doc-documentation.cpp)
target_link_libraries(doc-documentation
PRIVATE
continuable)

152
doc/code/documentation/doc-documentation.cpp
View File

@ -1,152 +0,0 @@
/*
Copyright(c) 2015 - 2018 Denis Blank <denis.blank at outlook dot com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files(the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
**/
#include <string>
#include <continuable/continuable.hpp>
#include <continuable/detail/util.hpp>
using cti::detail::util::unused;
void creating_continuables() {
auto void_continuable = cti::make_continuable<void>([](auto&& callback) {
// ^^^^
// Call the promise later when you have finished your work
callback.set_value();
});
auto str_continuable =
cti::make_continuable<std::string>([](auto&& callback) {
// ^^^^^^^^^^^
callback.set_value("Hello, World!");
});
}
struct ResultSet {};
template <typename... Args>
void mysql_handle_async_query(Args&&...) {
}
auto mysql_query(std::string query) {
return cti::make_continuable<ResultSet>([query = std::move(query)](
auto&& callback) mutable {
// Pass the callback to the handler which calls the callback when finished.
// Every function accepting callbacks works with continuables.
mysql_handle_async_query(std::move(query),
std::forward<decltype(callback)>(callback));
});
}
void providing_helper_functions() {
// You may use the helper function like you would normally do,
// without using the support methods of the continuable.
mysql_query("DELETE FROM `users` WHERE `id` = 27361");
// Or using chaining to handle the result which is covered in the
// documentation.
mysql_query("SELECT `id`, `name` FROM users").then([](ResultSet result) {
// ...
unused(result);
});
}
void chaining_continuables() {
mysql_query("SELECT `id`, `name` FROM `users`")
.then([](ResultSet users) {
(void)users;
// Return the next continuable to process ...
return mysql_query("SELECT `id` name FROM `sessions`");
})
.then([](ResultSet sessions) {
// ... or pass multiple values to the next callback using tuples or
// pairs ...
return std::make_tuple(std::move(sessions), true);
})
.then([](ResultSet sessions, bool is_ok) {
(void)sessions;
(void)is_ok;
// ... or pass a single value to the next callback ...
return 10;
})
.then([](auto value) {
// ^^^^ Templated callbacks are possible too
(void)value;
})
// ... you may even pass continuables to the `then` method directly:
.then(mysql_query("SELECT * `statistics`"))
.then([](ResultSet result) {
// ...
(void)result;
});
}
auto http_request(std::string /*url*/) {
return cti::make_continuable<std::string>([](auto&& callback) {
// ...
callback.set_value("<html>...</html>");
});
}
void connecting_continuables() {
// `all` of connections:
(http_request("github.com") && http_request("travis-ci.org") &&
http_request("atom.io"))
.then([](std::string github, std::string travis, std::string atom) {
// The callback is called with the response of github, travis and atom.
unused(github, travis, atom);
});
// `any` of connections:
(http_request("github.com") || http_request("travis-ci.org") ||
http_request("atom.io"))
.then([](std::string github_or_travis_or_atom) {
// The callback is called with the first response of either github,
// travis or atom.
unused(github_or_travis_or_atom);
});
// mixed logical connections:
(http_request("github.com") &&
(http_request("travis-ci.org") || http_request("atom.io")))
.then([](std::string github, std::string travis_or_atom) {
// The callback is called with the response of github for sure
// and the second parameter represents the response of travis or atom.
unused(github, travis_or_atom);
});
// There are helper functions for connecting continuables:
auto all =
cti::when_all(http_request("github.com"), http_request("travis-ci.org"));
auto any =
cti::when_any(http_request("github.com"), http_request("travis-ci.org"));
}
int main() {
creating_continuables();
providing_helper_functions();
chaining_continuables();
connecting_continuables();
}

5
doc/code/slideshow/CMakeLists.txt
View File

@ -1,5 +0,0 @@
add_executable(doc-slideshow
${CMAKE_CURRENT_LIST_DIR}/doc-slideshow.cpp)
target_link_libraries(doc-slideshow
PRIVATE
continuable)

1
examples/CMakeLists.txt
View File

@ -1,2 +1,3 @@
add_subdirectory(example-asio)
add_subdirectory(example-ai)
add_subdirectory(example-slideshow)

5
examples/example-slideshow/CMakeLists.txt Normal file
View File

@ -0,0 +1,5 @@
add_executable(example-slideshow
${CMAKE_CURRENT_LIST_DIR}/example-slideshow.cpp)
target_link_libraries(example-slideshow
PRIVATE
continuable)

44
doc/code/slideshow/doc-slideshow.cpp → examples/example-slideshow/example-slideshow.cpp
View File

@ -25,43 +25,32 @@
#include "continuable/continuable.hpp"
cti::continuable<std::string> http_request(std::string /*url*/) {
return [](auto&& callback) {
// ...
callback.set_value("<html>...</html>");
};
return cti::make_ready_continuable<std::string>("<html>...</html>");
}
struct ResultSet {};
struct Buffer {};
cti::continuable<ResultSet> mysql_query(std::string /*url*/) {
return [](auto&& callback) {
// ...
callback.set_value(ResultSet{});
};
return cti::make_ready_continuable(ResultSet{});
}
cti::continuable<Buffer> read_file(std::string /*url*/) {
return [](auto&& callback) {
// ...
callback.set_value(Buffer{});
};
return cti::make_ready_continuable(Buffer{});
}
struct a {
struct functional_executor {
auto post() const {
return [](auto&&) {};
}
};
int main(int, char**) {
a e;
functional_executor e;
auto executor = &e;
// clang-format off
// ----------
(http_request("github.com") && http_request("atom.io"))
.then([] (std::string /*github*/, std::string /*atom*/) {
// ...
@ -71,23 +60,15 @@ int main(int, char**) {
// ...
}, executor->post());
// ----------
// clang-format on
auto c1 = http_request("github.com") && http_request("atom.io") ;
http_request("github.com") && http_request("atom.io");
http_request("github.com") || http_request("atom.io");
http_request("github.com") >> http_request("atom.io");
auto c2 = http_request("github.com") || http_request("atom.io") ;
auto c3 = http_request("github.com") >> http_request("atom.io") ;
(void)c1;
(void)c2;
(void)c3;
// ----------
// clang-format off
read_file("entries.csv")
.then([] (Buffer /*buffer*/) {
@ -98,8 +79,7 @@ int main(int, char**) {
// ...
});
// ----------
// clang-format on
return 0;
}