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
71e80083
Commit
71e80083
authored
Nov 19, 2019
by
Jakob Otto
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Cleanup API Documentation
parent
7e4f1573
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
9 deletions
+9
-9
libcaf_net/caf/net/transport_base.hpp
libcaf_net/caf/net/transport_base.hpp
+9
-9
No files found.
libcaf_net/caf/net/transport_base.hpp
View file @
71e80083
...
@@ -26,7 +26,7 @@
...
@@ -26,7 +26,7 @@
namespace
caf
::
net
{
namespace
caf
::
net
{
/// Implements base class for transports.
/// Implements
a
base class for transports.
/// @tparam Transport The derived type of the transport implementation.
/// @tparam Transport The derived type of the transport implementation.
/// @tparam NextLayer The Following Layer. Either `transport_worker` or
/// @tparam NextLayer The Following Layer. Either `transport_worker` or
/// `transport_worker_dispatcher`
/// `transport_worker_dispatcher`
...
@@ -68,7 +68,7 @@ public:
...
@@ -68,7 +68,7 @@ public:
return
handle_
;
return
handle_
;
}
}
/// Returns a reference to the
actor_system
of this transport.
/// Returns a reference to the
`actor_system`
of this transport.
/// @pre `init` must be called before calling this getter.
/// @pre `init` must be called before calling this getter.
actor_system
&
system
()
{
actor_system
&
system
()
{
return
manager
().
system
();
return
manager
().
system
();
...
@@ -84,7 +84,7 @@ public:
...
@@ -84,7 +84,7 @@ public:
return
*
reinterpret_cast
<
transport_type
*>
(
this
);
return
*
reinterpret_cast
<
transport_type
*>
(
this
);
}
}
/// Returns a reference to the
endpoint_manager
of this transport.
/// Returns a reference to the
`endpoint_manager`
of this transport.
/// @pre `init` must be called before calling this getter.
/// @pre `init` must be called before calling this getter.
endpoint_manager
&
manager
()
{
endpoint_manager
&
manager
()
{
CAF_ASSERT
(
manager_
);
CAF_ASSERT
(
manager_
);
...
@@ -94,7 +94,7 @@ public:
...
@@ -94,7 +94,7 @@ public:
// -- transport member functions ---------------------------------------------
// -- transport member functions ---------------------------------------------
/// Initializes this transport.
/// Initializes this transport.
/// @param parent The
endpoint manager
that manages this transport.
/// @param parent The
`endpoint_manager`
that manages this transport.
/// @returns `error` on failure, none on success.
/// @returns `error` on failure, none on success.
virtual
error
init
(
endpoint_manager
&
parent
)
{
virtual
error
init
(
endpoint_manager
&
parent
)
{
CAF_LOG_TRACE
(
""
);
CAF_LOG_TRACE
(
""
);
...
@@ -112,7 +112,7 @@ public:
...
@@ -112,7 +112,7 @@ public:
}
}
/// Resolves a remote actor using `locator` and sends the resolved actor to
/// Resolves a remote actor using `locator` and sends the resolved actor to
/// listener on success - an
error
otherwise.
/// listener on success - an
`error`
otherwise.
/// @param locator The `uri` of the remote actor.
/// @param locator The `uri` of the remote actor.
/// @param listener The `actor_handle` which the result should be sent to.
/// @param listener The `actor_handle` which the result should be sent to.
auto
resolve
(
endpoint_manager
&
,
const
uri
&
locator
,
const
actor
&
listener
)
{
auto
resolve
(
endpoint_manager
&
,
const
uri
&
locator
,
const
actor
&
listener
)
{
...
@@ -128,9 +128,9 @@ public:
...
@@ -128,9 +128,9 @@ public:
f
(
next_layer_
);
f
(
next_layer_
);
}
}
/// Gets called by a
ctor_
proxy after creation.
/// Gets called by a
n actor
proxy after creation.
/// @param peer
the node_id
of the remote node.
/// @param peer
The `node_id`
of the remote node.
/// @param id
t
he id of the remote actor.
/// @param id
T
he id of the remote actor.
void
new_proxy
(
endpoint_manager
&
,
const
node_id
&
peer
,
actor_id
id
)
{
void
new_proxy
(
endpoint_manager
&
,
const
node_id
&
peer
,
actor_id
id
)
{
next_layer_
.
new_proxy
(
*
this
,
peer
,
id
);
next_layer_
.
new_proxy
(
*
this
,
peer
,
id
);
}
}
...
@@ -154,7 +154,7 @@ public:
...
@@ -154,7 +154,7 @@ public:
/// Callback for setting a timeout. Will be called after setting a timeout to
/// Callback for setting a timeout. Will be called after setting a timeout to
/// get the timeout id for local use.
/// get the timeout id for local use.
/// @param timeout_id The
timeout_
id of the previously set timeout.
/// @param timeout_id The id of the previously set timeout.
/// @param ts Any further information that was passed when setting the
/// @param ts Any further information that was passed when setting the
/// timeout.
/// timeout.
template
<
class
...
Ts
>
template
<
class
...
Ts
>
...
...
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