Skip to content

Commit

Permalink
#672: docs: more cleanup and fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
lifflander committed Jun 16, 2020
1 parent c3790d3 commit 2887c0f
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions src/active-messenger.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@
\page active-messenger Active Messenger
\brief Asynchronous send/receive of messages

The active messenger, accessed via `vt::theMsg()`, asynchronously sends and
receives messages across nodes using MPI internally. When sending a message, it
uses the \vt registry to consistently dispatch messages and data to handlers
(function pointers, functors, or methods) across nodes.
The active messenger `vt::messaging::ActiveMessenger`, accessed via
`vt::theMsg()`, asynchronously sends and receives messages across nodes using
MPI internally. When sending a message, it uses the \vt registry to consistently
dispatch messages and data to handlers (function pointers, functors, or methods)
across nodes.

Each message contains an envelope `vt::Envelope` to store meta-data associated
with the message, such as the destination and handler to trigger when it
Expand All @@ -16,8 +17,6 @@ destination node. On the receive side, the active messenger is always probing
for a incoming message and begins a transfer when it discovers one. The \vt
scheduler polls the active messenger to make progress on any incoming messages.

\copydoc vt::messaging::ActiveMessenger

\section am-simple-example Sending a message

\code{.cpp}
Expand Down

0 comments on commit 2887c0f

Please sign in to comment.