Skip to content

Commit ab74a58

Browse files
committed
Update docs (auto-build)
1 parent be9f5fe commit ab74a58

File tree

333 files changed

+22367
-20287
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

333 files changed

+22367
-20287
lines changed

docs/html/active_8h.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,10 @@ <h2><a href="#nested-classes">Classes</a></h2>
153153
struct <a href="structvt_1_1messaging_1_1_active_messenger.html" class="m-doc">vt::messaging::ActiveMessenger</a>
154154
</dt>
155155
<dd>Core component of VT used to send messages.</dd>
156+
<dt>
157+
struct <a href="structvt_1_1messaging_1_1_active_messenger_1_1_active_recv_broker_1_1_slot.html" class="m-doc">vt::messaging::ActiveMessenger::ActiveRecvBroker::Slot</a>
158+
</dt>
159+
<dd><span></span></dd>
156160
</dl>
157161
</section>
158162
</div>

docs/html/active_8h_source.html

Lines changed: 946 additions & 881 deletions
Large diffs are not rendered by default.

docs/html/active_8impl_8h_source.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,7 @@
609609
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_ae3c0b836a082ffb3f39d7610bdbe5b70"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#ae3c0b836a082ffb3f39d7610bdbe5b70">vt::messaging::ActiveMessenger::sendMsgSerializableImpl</a></div><div class="ttdeci">ActiveMessenger::PendingSendType sendMsgSerializableImpl(NodeType dest, HandlerType han, MsgSharedPtr&lt; MsgT &gt; &amp;msg, TagType tag)</div><div class="ttdef"><b>Definition:</b> active.impl.h:111</div></div>
610610
<div class="ttc" id="agroup__preregister_html_gad30a4e31445d40f9c3c36521fc04f975"><div class="ttname"><a href="group__preregister.html#gad30a4e31445d40f9c3c36521fc04f975">vt::messaging::ActiveMessenger::sendMsgAuto</a></div><div class="ttdeci">PendingSendType sendMsgAuto(NodeType dest, HandlerType han, MsgPtrThief&lt; MsgT &gt; msg, TagType tag=no_tag)</div><div class="ttdoc">Send a message with a pre-registered handler.</div><div class="ttdef"><b>Definition:</b> active.impl.h:222</div></div>
611611
<div class="ttc" id="aparam__msg_8impl_8h_html"><div class="ttname"><a href="param__msg_8impl_8h.html">param_msg.impl.h</a></div></div>
612-
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a4b1993ad77436b6ed6c7fd32801c50ed"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a4b1993ad77436b6ed6c7fd32801c50ed">vt::messaging::ActiveMessenger::UserSendFnType</a></div><div class="ttdeci">std::function&lt; void(SendFnType)&gt; UserSendFnType</div><div class="ttdef"><b>Definition:</b> active.h:328</div></div>
612+
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a4b1993ad77436b6ed6c7fd32801c50ed"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a4b1993ad77436b6ed6c7fd32801c50ed">vt::messaging::ActiveMessenger::UserSendFnType</a></div><div class="ttdeci">std::function&lt; void(SendFnType)&gt; UserSendFnType</div><div class="ttdef"><b>Definition:</b> active.h:334</div></div>
613613
<div class="ttc" id="aterm__headers_8h_html"><div class="ttname"><a href="term__headers_8h.html">term_headers.h</a></div></div>
614614
<div class="ttc" id="agroup__preregister_html_ga0d38199d7351ef980e166d8aaabe1be2"><div class="ttname"><a href="group__preregister.html#ga0d38199d7351ef980e166d8aaabe1be2">vt::messaging::ActiveMessenger::sendMsgSz</a></div><div class="ttdeci">PendingSendType sendMsgSz(NodeType dest, HandlerType han, MsgPtrThief&lt; MsgT &gt; msg, ByteType msg_size, TagType tag=no_tag)</div><div class="ttdoc">Send a message with a pre-registered handler.</div><div class="ttdef"><b>Definition:</b> active.impl.h:210</div></div>
615615
<div class="ttc" id="anamespacevt_html_ad5495e7900227550b44837e899c5bb13"><div class="ttname"><a href="namespacevt.html#ad5495e7900227550b44837e899c5bb13">vt::envelopeGetEpoch</a></div><div class="ttdeci">EpochType envelopeGetEpoch(Env const &amp;env)</div><div class="ttdoc">Get the epoch on an envelope; must be able to hold one.</div><div class="ttdef"><b>Definition:</b> envelope_extended_util.impl.h:53</div></div>
@@ -640,20 +640,20 @@
640640
<div class="ttc" id="athread__action_8h_html"><div class="ttname"><a href="thread__action_8h.html">thread_action.h</a></div></div>
641641
<div class="ttc" id="astructvt_1_1messaging_1_1_msg_shared_ptr_html"><div class="ttname"><a href="structvt_1_1messaging_1_1_msg_shared_ptr.html">vt::messaging::MsgSharedPtr&lt; MsgT &gt;</a></div></div>
642642
<div class="ttc" id="astructvt_1_1messaging_1_1is__byte__copyable__t_html"><div class="ttname"><a href="structvt_1_1messaging_1_1is__byte__copyable__t.html">vt::messaging::is_byte_copyable_t</a></div><div class="ttdef"><b>Definition:</b> message_serialize.h:248</div></div>
643-
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a44428f493f635833b6b8da6a6dfcf08f"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a44428f493f635833b6b8da6a6dfcf08f">vt::messaging::ActiveMessenger::this_node_</a></div><div class="ttdeci">NodeType this_node_</div><div class="ttdef"><b>Definition:</b> active.h:1752</div></div>
643+
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a44428f493f635833b6b8da6a6dfcf08f"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a44428f493f635833b6b8da6a6dfcf08f">vt::messaging::ActiveMessenger::this_node_</a></div><div class="ttdeci">NodeType this_node_</div><div class="ttdef"><b>Definition:</b> active.h:1805</div></div>
644644
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_aa60710a2d4a1ac7fe60113fd8cbb9809"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#aa60710a2d4a1ac7fe60113fd8cbb9809">vt::messaging::ActiveMessenger::getEpochContextMsg</a></div><div class="ttdeci">EpochType getEpochContextMsg(MsgT *msg)</div><div class="ttdoc">Get the epoch for a message based on the current context so an subsequent operation on it can be safe...</div><div class="ttdef"><b>Definition:</b> active.impl.h:473</div></div>
645645
<div class="ttc" id="anamespacevt_html_aeda768e2b7668340d73e5254a6b2923f"><div class="ttname"><a href="namespacevt.html#aeda768e2b7668340d73e5254a6b2923f">vt::envelopeSetIsLocked</a></div><div class="ttdeci">void envelopeSetIsLocked(Env &amp;env, bool is_locked)</div><div class="ttdoc">Set whether this message's envelope is locked.</div><div class="ttdef"><b>Definition:</b> envelope_set.impl.h:163</div></div>
646646
<div class="ttc" id="anamespacevt_html_af6e10f3d27abb3321ca34830880c0f7a"><div class="ttname"><a href="namespacevt.html#af6e10f3d27abb3321ca34830880c0f7a">vt::setBroadcastType</a></div><div class="ttdeci">void setBroadcastType(Env &amp;env, bool deliver_to_sender=true)</div><div class="ttdoc">Set broadcast bit (changes how dest is interpreted) EnvBroadcast.</div><div class="ttdef"><b>Definition:</b> envelope_set.impl.h:78</div></div>
647647
<div class="ttc" id="anamespacevt_1_1messaging_html_ad1743de9163dc74a43e6a95e28f49462"><div class="ttname"><a href="namespacevt_1_1messaging.html#ad1743de9163dc74a43e6a95e28f49462">vt::messaging::envelopeIsTerm</a></div><div class="ttdeci">bool envelopeIsTerm(Env const &amp;env)</div><div class="ttdoc">Test if envelope type is term EnvTerm.</div><div class="ttdef"><b>Definition:</b> envelope_test.impl.h:55</div></div>
648648
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a7b5a8fc73617491423bf68c4fbe1e2a2"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a7b5a8fc73617491423bf68c4fbe1e2a2">vt::messaging::ActiveMessenger::setupEpochMsg</a></div><div class="ttdeci">EpochType setupEpochMsg(MsgT *msg)</div><div class="ttdoc">Set the epoch on a message.</div><div class="ttdef"><b>Definition:</b> active.impl.h:506</div></div>
649-
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a3626a6ca76d8ad4ec7c3b47a2c70d3a8"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a3626a6ca76d8ad4ec7c3b47a2c70d3a8">vt::messaging::ActiveMessenger::PendingSendType</a></div><div class="ttdeci">PendingSend PendingSendType</div><div class="ttdef"><b>Definition:</b> active.h:332</div></div>
649+
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a3626a6ca76d8ad4ec7c3b47a2c70d3a8"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a3626a6ca76d8ad4ec7c3b47a2c70d3a8">vt::messaging::ActiveMessenger::PendingSendType</a></div><div class="ttdeci">PendingSend PendingSendType</div><div class="ttdef"><b>Definition:</b> active.h:338</div></div>
650650
<div class="ttc" id="anamespacevt_html"><div class="ttname"><a href="namespacevt.html">vt</a></div><div class="ttdef"><b>Definition:</b> activefn.h:51</div></div>
651651
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a4234a56f6c50c0c0a0eefd3f3f66b58e"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a4234a56f6c50c0c0a0eefd3f3f66b58e">vt::messaging::ActiveMessenger::sendMsgCopyableImpl</a></div><div class="ttdeci">ActiveMessenger::PendingSendType sendMsgCopyableImpl(NodeType dest, HandlerType han, MsgSharedPtr&lt; MsgT &gt; &amp;msg, TagType tag)</div><div class="ttdef"><b>Definition:</b> active.impl.h:147</div></div>
652652
<div class="ttc" id="astructvt_1_1util_1_1_functor_extractor_html_a6da3f67871dbf871f832dd5efad726d4"><div class="ttname"><a href="structvt_1_1util_1_1_functor_extractor.html#a6da3f67871dbf871f832dd5efad726d4">vt::util::FunctorExtractor::MessageType</a></div><div class="ttdeci">MessageT MessageType</div><div class="ttdef"><b>Definition:</b> functor.h:77</div></div>
653653
<div class="ttc" id="aactive_8h_html"><div class="ttname"><a href="active_8h.html">active.h</a></div></div>
654654
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_ab6d3637cb3c416b3491b748aaf4bab48"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#ab6d3637cb3c416b3491b748aaf4bab48">vt::messaging::ActiveMessenger::setTagMessage</a></div><div class="ttdeci">void setTagMessage(MsgT *msg, TagType tag)</div><div class="ttdoc">Set the tag in the envelope of a message.</div><div class="ttdef"><b>Definition:</b> active.impl.h:106</div></div>
655655
<div class="ttc" id="anamespacevt_html_a127580fdfcaba0b4171e5c48c5676733"><div class="ttname"><a href="namespacevt.html#a127580fdfcaba0b4171e5c48c5676733">vt::theTerm</a></div><div class="ttdeci">term::TerminationDetector * theTerm()</div><div class="ttdef"><b>Definition:</b> runtime_get.cc:106</div></div>
656-
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a42112dea411907ca529bd5bc6586249a"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a42112dea411907ca529bd5bc6586249a">vt::messaging::ActiveMessenger::name</a></div><div class="ttdeci">std::string name() override</div><div class="ttdoc">Get the name of the component.</div><div class="ttdef"><b>Definition:</b> active.h:344</div></div>
656+
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a42112dea411907ca529bd5bc6586249a"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a42112dea411907ca529bd5bc6586249a">vt::messaging::ActiveMessenger::name</a></div><div class="ttdeci">std::string name() override</div><div class="ttdoc">Get the name of the component.</div><div class="ttdef"><b>Definition:</b> active.h:350</div></div>
657657
<div class="ttc" id="anamespacevt_1_1messaging_html_a11d2b356f56486f2e60f0255cb6b05ff"><div class="ttname"><a href="namespacevt_1_1messaging.html#a11d2b356f56486f2e60f0255cb6b05ff">vt::messaging::broadcast_dest</a></div><div class="ttdeci">constexpr NodeType broadcast_dest</div><div class="ttdef"><b>Definition:</b> active.impl.h:60</div></div>
658658
<div class="ttc" id="anamespacevt_html_a0eb7eef640bbf48bff94e6683be7a3dd"><div class="ttname"><a href="namespacevt.html#a0eb7eef640bbf48bff94e6683be7a3dd">vt::envelopeSetTag</a></div><div class="ttdeci">void envelopeSetTag(Env &amp;env, TagType const &amp;tag)</div><div class="ttdoc">Set the tag on an envelope; must be able to hold one.</div><div class="ttdef"><b>Definition:</b> envelope_extended_util.impl.h:88</div></div>
659659
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a0ff3c2d9bf6ccd66002679b93821229c"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a0ff3c2d9bf6ccd66002679b93821229c">vt::messaging::ActiveMessenger::popEpoch</a></div><div class="ttdeci">EpochType popEpoch(EpochType const &amp;epoch=no_epoch)</div><div class="ttdoc">Pop an epoch off the stack.</div><div class="ttdef"><b>Definition:</b> active.impl.h:464</div></div>
@@ -663,7 +663,7 @@
663663
<div class="ttc" id="agroup__preregister_html_ga0162a39473e7f9b490a79a7983d949ac"><div class="ttname"><a href="group__preregister.html#ga0162a39473e7f9b490a79a7983d949ac">vt::messaging::ActiveMessenger::sendMsg</a></div><div class="ttdeci">PendingSendType sendMsg(NodeType dest, HandlerType han, MsgPtrThief&lt; MsgT &gt; msg, TagType tag=no_tag)</div><div class="ttdoc">Send a message with a pre-registered handler.</div><div class="ttdef"><b>Definition:</b> active.impl.h:199</div></div>
664664
<div class="ttc" id="astructvt_1_1term_1_1_termination_detector_html_a81a7f955e09f59a85303bfcb90414882"><div class="ttname"><a href="structvt_1_1term_1_1_termination_detector.html#a81a7f955e09f59a85303bfcb90414882">vt::term::TerminationDetector::popEpoch</a></div><div class="ttdeci">EpochType popEpoch(EpochType epoch=no_epoch)</div><div class="ttdef"><b>Definition:</b> termination.impl.h:162</div></div>
665665
<div class="ttc" id="anamespacevt_html_a3f298caa64a97f60a0772b74cad8b620"><div class="ttname"><a href="namespacevt.html#a3f298caa64a97f60a0772b74cad8b620">vt::envelopeGetDeliverBcast</a></div><div class="ttdeci">bool envelopeGetDeliverBcast(Env const &amp;env)</div><div class="ttdoc">Check whether bcast should be delivered to sender.</div><div class="ttdef"><b>Definition:</b> envelope_get.impl.h:63</div></div>
666-
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a98c8e157b97812c677debc8a25ec392d"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a98c8e157b97812c677debc8a25ec392d">vt::messaging::ActiveMessenger::sendData</a></div><div class="ttdeci">SendInfo sendData(PtrLenPairType const &amp;ptr, NodeType const &amp;dest, TagType const &amp;tag)</div><div class="ttdoc">Send raw bytes to a node.</div><div class="ttdef"><b>Definition:</b> active.cc:528</div></div>
666+
<div class="ttc" id="astructvt_1_1messaging_1_1_active_messenger_html_a98c8e157b97812c677debc8a25ec392d"><div class="ttname"><a href="structvt_1_1messaging_1_1_active_messenger.html#a98c8e157b97812c677debc8a25ec392d">vt::messaging::ActiveMessenger::sendData</a></div><div class="ttdeci">SendInfo sendData(PtrLenPairType const &amp;ptr, NodeType const &amp;dest, TagType const &amp;tag)</div><div class="ttdoc">Send raw bytes to a node.</div><div class="ttdef"><b>Definition:</b> active.cc:543</div></div>
667667
<div class="ttc" id="aconfig_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div></div>
668668
<div class="ttc" id="adebug__printconst_8h_html_a2a030f018eca8f4bd882d5cf74a80674"><div class="ttname"><a href="debug__printconst_8h.html#a2a030f018eca8f4bd882d5cf74a80674">print_ptr</a></div><div class="ttdeci">#define print_ptr(PTR)</div><div class="ttdef"><b>Definition:</b> debug_printconst.h:53</div></div>
669669
<div class="ttc" id="adebug__print_8h_html_ab994f04eda64129ff010c6fcea609ecb"><div class="ttname"><a href="debug__print_8h.html#ab994f04eda64129ff010c6fcea609ecb">vt_debug_print</a></div><div class="ttdeci">#define vt_debug_print(type, feature,...)</div><div class="ttdef"><b>Definition:</b> debug_print.h:103</div></div>

0 commit comments

Comments
 (0)