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
8dbf1266
Commit
8dbf1266
authored
Dec 11, 2014
by
Dominik Charousset
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix Doxygen comments
parent
4f47cb6d
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
51 additions
and
40 deletions
+51
-40
libcaf_core/caf/abstract_actor.hpp
libcaf_core/caf/abstract_actor.hpp
+0
-4
libcaf_core/caf/detail/comparable.hpp
libcaf_core/caf/detail/comparable.hpp
+3
-3
libcaf_core/caf/detail/type_traits.hpp
libcaf_core/caf/detail/type_traits.hpp
+2
-2
libcaf_io/caf/io/basp.hpp
libcaf_io/caf/io/basp.hpp
+46
-31
No files found.
libcaf_core/caf/abstract_actor.hpp
View file @
8dbf1266
...
@@ -78,16 +78,12 @@ class abstract_actor : public abstract_channel {
...
@@ -78,16 +78,12 @@ class abstract_actor : public abstract_channel {
/**
/**
* Attaches `ptr` to this actor. The actor will call `ptr->detach(...)` on
* Attaches `ptr` to this actor. The actor will call `ptr->detach(...)` on
* exit, or immediately if it already finished execution.
* exit, or immediately if it already finished execution.
* @returns `true` if `ptr` was successfully attached to the actor,
* otherwise (actor already exited) `false`.
*/
*/
void
attach
(
attachable_ptr
ptr
);
void
attach
(
attachable_ptr
ptr
);
/**
/**
* Convenience function that attaches the functor `f` to this actor. The
* Convenience function that attaches the functor `f` to this actor. The
* actor executes `f()` on exit or immediatley if it is not running.
* actor executes `f()` on exit or immediatley if it is not running.
* @returns `true` if `f` was successfully attached to the actor,
* otherwise (actor already exited) `false`.
*/
*/
template
<
class
F
>
template
<
class
F
>
void
attach_functor
(
F
f
)
{
void
attach_functor
(
F
f
)
{
...
...
libcaf_core/caf/detail/comparable.hpp
View file @
8dbf1266
...
@@ -27,9 +27,9 @@ namespace detail {
...
@@ -27,9 +27,9 @@ namespace detail {
* Barton–Nackman trick implementation.
* Barton–Nackman trick implementation.
* `Subclass` must provide a compare member function that compares
* `Subclass` must provide a compare member function that compares
* to instances of `T` and returns an integer x with:
* to instances of `T` and returns an integer x with:
* - `x < 0
</tt> if <tt>*this < other
* - `x < 0
` if `*this < other`
* - `x > 0
</tt> if <tt>*this > other
* - `x > 0
` if `*this > other`
* - `x == 0
</tt> if <tt>*this == other
* - `x == 0
` if `*this == other`
*/
*/
template
<
class
Subclass
,
class
T
=
Subclass
>
template
<
class
Subclass
,
class
T
=
Subclass
>
class
comparable
{
class
comparable
{
...
...
libcaf_core/caf/detail/type_traits.hpp
View file @
8dbf1266
...
@@ -207,8 +207,8 @@ class is_forward_iterator {
...
@@ -207,8 +207,8 @@ class is_forward_iterator {
};
};
/**
/**
* Checks wheter `T` has `begin()
</tt> and <tt>end()
member
* Checks wheter `T` has `begin()
` and `end()`
member
*
functions returning forward iterators.
* functions returning forward iterators.
*/
*/
template
<
class
T
>
template
<
class
T
>
class
is_iterable
{
class
is_iterable
{
...
...
libcaf_io/caf/io/basp.hpp
View file @
8dbf1266
...
@@ -81,12 +81,15 @@ inline bool nonzero(T aid) {
...
@@ -81,12 +81,15 @@ inline bool nonzero(T aid) {
/**
/**
* Send from server, i.e., the node with a published actor, to client,
* Send from server, i.e., the node with a published actor, to client,
* i.e., node that initiates a new connection using remote_actor().
* i.e., node that initiates a new connection using remote_actor().
* @param source_node ID of server
*
* @param dest_node invalid
* Field | Assignment
* @param source_actor Optional: ID of published actor
* ---------------|----------------------------------------------------------
* @param dest_actor 0
* source_node | ID of server
* @param payload_len Optional: size of actor id + interface definition
* dest_node | invalid
* @param operation_data BASP version of the server
* source_actor | Optional: ID of published actor
* dest_actor | 0
* payload_len | Optional: size of actor id + interface definition
* operation_data | BASP version of the server
*/
*/
constexpr
uint32_t
server_handshake
=
0x00
;
constexpr
uint32_t
server_handshake
=
0x00
;
...
@@ -96,18 +99,21 @@ inline bool server_handshake_valid(const header& hdr) {
...
@@ -96,18 +99,21 @@ inline bool server_handshake_valid(const header& hdr) {
&&
zero
(
hdr
.
dest_actor
)
&&
zero
(
hdr
.
dest_actor
)
&&
nonzero
(
hdr
.
operation_data
)
&&
nonzero
(
hdr
.
operation_data
)
&&
(
(
nonzero
(
hdr
.
source_actor
)
&&
nonzero
(
hdr
.
payload_len
))
&&
(
(
nonzero
(
hdr
.
source_actor
)
&&
nonzero
(
hdr
.
payload_len
))
||
(
zero
(
hdr
.
source_actor
)
&&
zero
(
hdr
.
payload_len
)));
||
(
zero
(
hdr
.
source_actor
)
&&
zero
(
hdr
.
payload_len
)));
}
}
/**
/**
* Send from client to server after it has successfully received the
* Send from client to server after it has successfully received the
* server_handshake to establish the connection.
* server_handshake to establish the connection.
* @param source_node ID of client
*
* @param dest_node ID of server
* Field | Assignment
* @param source_actor 0
* ---------------|----------------------------------------------------------
* @param dest_actor 0
* source_node | ID of client
* @param payload_len 0
* dest_node | ID of server
* @param operation_data 0
* source_actor | 0
* dest_actor | 0
* payload_len | 0
* operation_data | 0
*/
*/
constexpr
uint32_t
client_handshake
=
0x01
;
constexpr
uint32_t
client_handshake
=
0x01
;
...
@@ -124,12 +130,15 @@ inline bool client_handshake_valid(const header& hdr) {
...
@@ -124,12 +130,15 @@ inline bool client_handshake_valid(const header& hdr) {
/**
/**
* Transmits a message from source_node:source_actor to
* Transmits a message from source_node:source_actor to
* dest_node:dest_actor.
* dest_node:dest_actor.
* @param source_node ID of sending node (invalid in case of anon_send)
*
* @param dest_node ID of receiving node
* Field | Assignment
* @param source_actor ID of sending actor (invalid in case of anon_send)
* ---------------|----------------------------------------------------------
* @param dest_actor ID of receiving actor, must not be invalid
* source_node | ID of sending node (invalid in case of anon_send)
* @param payload_len size of serialized message object, must not be 0
* dest_node | ID of receiving node
* @param operation_data message ID (0 for asynchronous messages)
* source_actor | ID of sending actor (invalid in case of anon_send)
* dest_actor | ID of receiving actor, must not be invalid
* payload_len | size of serialized message object, must not be 0
* operation_data | message ID (0 for asynchronous messages)
*/
*/
constexpr
uint32_t
dispatch_message
=
0x02
;
constexpr
uint32_t
dispatch_message
=
0x02
;
...
@@ -144,12 +153,15 @@ inline bool dispatch_message_valid(const header& hdr) {
...
@@ -144,12 +153,15 @@ inline bool dispatch_message_valid(const header& hdr) {
* instance for one of its actors. Causes the receiving node to attach
* instance for one of its actors. Causes the receiving node to attach
* a functor to the actor that triggers a kill_proxy_instance
* a functor to the actor that triggers a kill_proxy_instance
* message on termination.
* message on termination.
* @param source_node ID of sending node
*
* @param dest_node ID of receiving node
* Field | Assignment
* @param source_actor 0
* ---------------|----------------------------------------------------------
* @param dest_actor ID of monitored actor
* source_node | ID of sending node
* @param payload_len 0
* dest_node | ID of receiving node
* @param operation_data 0
* source_actor | 0
* dest_actor | ID of monitored actor
* payload_len | 0
* operation_data | 0
*/
*/
constexpr
uint32_t
announce_proxy_instance
=
0x03
;
constexpr
uint32_t
announce_proxy_instance
=
0x03
;
...
@@ -166,12 +178,15 @@ inline bool announce_proxy_instance_valid(const header& hdr) {
...
@@ -166,12 +178,15 @@ inline bool announce_proxy_instance_valid(const header& hdr) {
/**
/**
* Informs the receiving node that it has a proxy for an actor
* Informs the receiving node that it has a proxy for an actor
* that has been terminated.
* that has been terminated.
* @param source_node ID of sending node
*
* @param dest_node ID of receiving node
* Field | Assignment
* @param source_actor ID of monitored actor
* ---------------|----------------------------------------------------------
* @param dest_actor 0
* source_node | ID of sending node
* @param payload_len 0
* dest_node | ID of receiving node
* @param operation_data exit reason (uint32)
* source_actor | ID of monitored actor
* dest_actor | 0
* payload_len | 0
* operation_data | exit reason (uint32)
*/
*/
constexpr
uint32_t
kill_proxy_instance
=
0x04
;
constexpr
uint32_t
kill_proxy_instance
=
0x04
;
...
...
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