Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
A
Actor Framework
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Metrics
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
cpp-libs
Actor Framework
Commits
aabd1228
Commit
aabd1228
authored
Jan 26, 2018
by
Joseph Noir
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update examples and links in the all header
parent
b8b76c36
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
77 additions
and
67 deletions
+77
-67
libcaf_core/caf/all.hpp
libcaf_core/caf/all.hpp
+77
-67
No files found.
libcaf_core/caf/all.hpp
View file @
aabd1228
...
@@ -128,38 +128,33 @@
...
@@ -128,38 +128,33 @@
/// an own thread if one needs to make use of blocking APIs.
/// an own thread if one needs to make use of blocking APIs.
///
///
/// Writing applications in `libcaf` requires a minimum of gluecode and
/// Writing applications in `libcaf` requires a minimum of gluecode and
/// each context <i>is</i> an actor.
Even main is implicitly
/// each context <i>is</i> an actor.
Scoped actors allow actor interaction
///
converted to an actor if needed
.
///
from the context of threads such as main
.
///
///
/// @section GettingStarted Getting Started
/// @section GettingStarted Getting Started
///
///
/// To build `libcaf,` you need `GCC >= 4.8 or <tt>Clang >=
/// To build `libcaf,` you need `GCC >= 4.8 or <tt>Clang >= 3.2</tt>,
///3.2</tt>,
/// and `CMake`.
/// and `CMake`.
///
///
/// The usual build steps on Linux and
Mac OS X
are:
/// The usual build steps on Linux and
macOS
are:
///
///
///- `mkdir build
///- `./configure
///- `cd build
///- `cmake ..
///- `make
///- `make
///- `make install (as root, optionally)
///- `make install (as root, optionally)
///
///
/// Please run the unit tests as well to verify that `libcaf`
/// Please run the unit tests as well to verify that `libcaf`
/// works properly.
/// works properly.
///
///
///- `
./bin/unit_tests
///- `
make test
///
///
/// Please submit a bug report that includes (a) your compiler version,
/// Please submit a bug report that includes (a) your compiler version,
/// (b) your OS, and (c) the output of the unit tests if an error occurs.
/// (b) your OS, and (c) the output of the unit tests if an error occurs:
///
/// https://github.com/actor-framework/actor-framework/issues
/// Windows is not supported yet, because MVSC++ doesn't implement the
/// C++11 features needed to compile `libcaf`.
///
///
/// Please read the <b>Manual</b> for an introduction to `libcaf`.
/// Please read the <b>Manual</b> for an introduction to `libcaf`.
/// It is available online
as HTML
at
/// It is available online
on Read The Docs
at
/// http
://neverlord.github.com/libcaf/manual/index.html
or as PDF at
/// http
s://actor-framework.readthedocs.io
or as PDF at
/// http://
neverlord.github.com/libcaf/manual
/manual.pdf
/// http://
www.actor-framework.org/pdf
/manual.pdf
///
///
/// @section IntroHelloWorld Hello World Example
/// @section IntroHelloWorld Hello World Example
///
///
...
@@ -218,37 +213,56 @@
...
@@ -218,37 +213,56 @@
///
///
/// ~~
/// ~~
/// // spawn some actors
/// // spawn some actors
/// auto a1 = spawn(...);
/// actor_system_config cfg;
/// auto a2 = spawn(...);
/// actor_system system{cfg};
/// auto a3 = spawn(...);
/// auto a1 = system.spawn(...);
/// auto a2 = system.spawn(...);
/// auto a3 = system.spawn(...);
///
/// // an actor executed in the current thread
/// scoped_actor self{system};
///
/// // define an atom for message annotation
/// using hello_atom = atom_constant<atom("hello")>;
/// using compute_atom = atom_constant<atom("compute")>;
/// using result_atom = atom_constant<atom("result")>;
///
///
/// // send a message to a1
/// // send a message to a1
/// se
nd(a1, atom("hello")
, "hello a1!");
/// se
lf->send(a1, hello_atom::value
, "hello a1!");
///
///
/// // send a message to a1, a2, and a3
/// // send a message to a1, a2, and a3
/// auto msg = make_message(
atom("compute")
, 1, 2, 3);
/// auto msg = make_message(
compute_atom::value
, 1, 2, 3);
/// send(a1, msg);
/// se
lf->se
nd(a1, msg);
/// send(a2, msg);
/// se
lf->se
nd(a2, msg);
/// send(a3, msg);
/// se
lf->se
nd(a3, msg);
/// ~~
/// ~~
///
///
/// @section Receive Receive messages
/// @section Receive Receive messages
///
///
/// The function `receive` takes a `behavior` as argument. The behavior
/// The function `receive` takes a `behavior` as argument. The behavior
/// is a list of { pattern >> callback } rules.
/// is a list of { callback } rules where the callback argument types
/// define a pattern for matching messages.
///
///
/// ~~
/// ~~
/// receive
/// {
/// (
/// [](hello_atom, const std::string& msg) {
/// on(atom("hello"), arg_match) >> [](const std::string& msg)
/// {
/// cout << "received hello message: " << msg << endl;
/// cout << "received hello message: " << msg << endl;
/// },
/// },
/// on(atom("compute"), arg_match) >> [](int i0, int i1, int i2)
/// [](compute_atom, int i0, int i1, int i2) {
/// {
/// // send our result back to the sender of this messages
/// // send our result back to the sender of this messages
/// return make_message(
atom("result")
, i0 + i1 + i2);
/// return make_message(
result_atom::value
, i0 + i1 + i2);
/// }
/// }
/// }
/// ~~
///
/// Blocking actors such as the scoped actor can call their receive member
/// to handle incoming messages.
///
/// ~~
/// self->receive(
/// [](result_atom, int i) {
/// cout << "result is: " << i << endl;
/// }
/// );
/// );
/// ~~
/// ~~
///
///
...
@@ -264,42 +278,40 @@
...
@@ -264,42 +278,40 @@
///
///
/// Example actor:
/// Example actor:
/// ~~
/// ~~
/// void math_actor() {
/// using plus_atom = atom_constant<atom("plus")>;
/// receive_loop (
/// using minus_atom = atom_constant<atom("minus")>;
/// on(atom("plus"), arg_match) >> [](int a, int b) {
/// behavior math_actor() {
/// return {
/// [](plus_atom, int a, int b) {
/// return make_message(atom("result"), a + b);
/// return make_message(atom("result"), a + b);
/// },
/// },
///
on(atom("minus"), arg_match) >> [](
int a, int b) {
///
[](minus_atom,
int a, int b) {
/// return make_message(atom("result"), a - b);
/// return make_message(atom("result"), a - b);
/// }
/// }
///
)
;
///
}
;
/// }
/// }
/// ~~
/// ~~
///
///
/// @section ReceiveLoops Receive Loops
/// @section ReceiveLoops Receive Loops
///
///
///
Previous examples using `receive` create behaviors
on-the-fly.
///
The previous examples used `receive` to create a behavior
on-the-fly.
/// This is inefficient in a loop since the argument passed to receive
/// This is inefficient in a loop since the argument passed to receive
/// is created in each iteration again. It's possible to store the behavior
/// is created in each iteration again. It's possible to store the behavior
/// in a variable and pass that variable to receive. This fixes the issue
/// in a variable and pass that variable to receive. This fixes the issue
/// of re-creation each iteration but rips apart definition and usage.
/// of re-creation each iteration but rips apart definition and usage.
///
///
/// There are
four
convenience functions implementing receive loops to
/// There are
three
convenience functions implementing receive loops to
/// declare behavior where it belongs without unnecessary
/// declare behavior where it belongs without unnecessary
/// copies: `receive_loop,` `receive_while,` `receive_for` and `do_receive`.
/// copies: `receive_while,` `receive_for` and `do_receive`.
///
/// `receive_loop` is analogous to `receive` and loops "forever" (until the
/// actor finishes execution).
///
///
/// `receive_while` creates a functor evaluating a lambda expression.
/// `receive_while` creates a functor evaluating a lambda expression.
/// The loop continues until the given lambda returns `false`. A simple example:
/// The loop continues until the given lambda returns `false`. A simple example:
///
///
/// ~~
/// ~~
/// // receive two integers
/// size_t received = 0;
/// vector<int> received_values;
/// receive_while([&] { return received < 10; }) (
/// receive_while([&]() { return received_values.size() < 2; }) (
/// [&](int) {
/// on<int>() >> [](int value) {
/// ++received;
/// received_values.push_back(value);
/// }
/// }
/// );
/// );
/// // ...
/// // ...
...
@@ -308,10 +320,12 @@
...
@@ -308,10 +320,12 @@
/// `receive_for` is a simple ranged-based loop:
/// `receive_for` is a simple ranged-based loop:
///
///
/// ~~
/// ~~
/// std::vector<int> vec {1, 2, 3, 4};
/// std::vector<int> results;
/// auto i = vec.begin();
/// size_t i = 0;
/// receive_for(i, vec.end()) (
/// receive_for(i, 10) (
/// on(atom("get")) >> [&]() -> message { return {atom("result"), *i}; }
/// [&](int value) {
/// results.push_back(value);
/// }
/// );
/// );
/// ~~
/// ~~
///
///
...
@@ -320,14 +334,12 @@
...
@@ -320,14 +334,12 @@
/// returns true. Example:
/// returns true. Example:
///
///
/// ~~
/// ~~
/// // receive ints until zero was received
/// size_t received = 0;
/// vector<int> received_values;
/// do_receive (
/// do_receive (
///
on<int>() >> [](int value
) {
///
[&](int
) {
///
received_values.push_back(value)
;
///
++received
;
/// }
/// }
/// )
/// ).until([&] { return received >= 10; });
/// .until([&]() { return received_values.back() == 0 });
/// // ...
/// // ...
/// ~~
/// ~~
///
///
...
@@ -338,13 +350,16 @@
...
@@ -338,13 +350,16 @@
/// Usage example:
/// Usage example:
///
///
/// ~~
/// ~~
/// delayed_send(self, std::chrono::seconds(1), poll_atom::value);
/// scoped_actor self{...};
/// receive_loop (
///
/// self->delayed_send(self, std::chrono::seconds(1), poll_atom::value);
/// bool running = true;
/// self->receive_while([&](){ return running; }) (
/// // ...
/// // ...
/// [](poll_atom) {
/// [
&
](poll_atom) {
/// // ... poll something ...
/// // ... poll something ...
/// // and do it again after 1sec
/// // and do it again after 1sec
/// delayed_send(self, std::chrono::seconds(1), poll_atom::value);
///
self->
delayed_send(self, std::chrono::seconds(1), poll_atom::value);
/// }
/// }
/// );
/// );
/// ~~
/// ~~
...
@@ -374,11 +389,6 @@
...
@@ -374,11 +389,6 @@
///
///
/// // x has the type caf::tuple<std::string, std::string>
/// // x has the type caf::tuple<std::string, std::string>
/// auto x = make_message("hello", "tuple");
/// auto x = make_message("hello", "tuple");
///
/// receive (
/// // equal to: on(std::string("hello actor!"))
/// on("hello actor!") >> [] { }
/// );
/// ~~
/// ~~
///
///
/// @defgroup ActorCreation Creating Actors
/// @defgroup ActorCreation Creating Actors
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment