Skip to content

Commit 7039394

Browse files
author
github-actions
committed
Sync documentation from Code repo to Pages repo. Possibly update root-page links.
1 parent 21570d7 commit 7039394

File tree

1,876 files changed

+11350
-8628
lines changed

Some content is hidden

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

1,876 files changed

+11350
-8628
lines changed

doc/flow-ipc/versions/main/generated/html_full/about.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ <h2>Future directions of work </h2>
132132
</div><!-- PageDoc -->
133133
<!-- start footer part -->
134134
<hr class="footer"/><address class="footer"><small>
135-
Generated on Thu Dec 12 2024 06:10:33 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
135+
Generated on Sat Dec 21 2024 00:38:32 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
136136
</small></address>
137137
</body>
138138
</html>

doc/flow-ipc/versions/main/generated/html_full/annotated.html

Lines changed: 165 additions & 162 deletions
Large diffs are not rendered by default.

doc/flow-ipc/versions/main/generated/html_full/api_overview.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -652,7 +652,7 @@ <h2>Direct storage in SHared Memory (SHM) </h2>
652652
<div class="line"><span class="comment">// We can write to it too, in most cases.</span></div>
653653
<div class="line">x-&gt;m_str[0] = <span class="charliteral">&#39;Y&#39;</span>;</div>
654654
<div class="line"><span class="comment">// (Can modify with allocations too, as long as you use an Activator context again, same as in owner process above.)</span></div>
655-
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_html_adb38fe88cfd5e758ef52c482d2902669"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm.html#adb38fe88cfd5e758ef52c482d2902669">ipc::transport::struc::shm::capnp_get_shm_handle_to_borrow</a></div><div class="ttdeci">void capnp_get_shm_handle_to_borrow(const schema::ShmHandle::Reader &amp;shm_handle_root, flow::util::Blob_sans_log_context *arg_to_borrow)</div><div class="ttdoc">Utility that's the reverse of capnp_set_lent_shm_handle() to be invoked on the deserializing side.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2util_8cpp_source.html#l00050">util.cpp:50</a></div></div>
655+
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_html_adb38fe88cfd5e758ef52c482d2902669"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm.html#adb38fe88cfd5e758ef52c482d2902669">ipc::transport::struc::shm::capnp_get_shm_handle_to_borrow</a></div><div class="ttdeci">void capnp_get_shm_handle_to_borrow(const schema::ShmHandle::Reader &amp;shm_handle_root, flow::util::Blob_sans_log_context *arg_to_borrow)</div><div class="ttdoc">Utility that's the reverse of capnp_set_lent_shm_handle() to be invoked on the deserializing side.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__shm_2src_2ipc_2transport_2struc_2shm_2util_8cpp_source.html#l00051">util.cpp:51</a></div></div>
656656
</div><!-- fragment --> </blockquote>
657657
<p>When one gets into this relatively advanced area, there are differences and trade-offs between the available SHM-providers. If your alias at the very top is <code>using ssn = <a class="el" href="namespaceipc_1_1session_1_1shm_1_1classic.html" title="Support for SHM-backed ipc::session sessions and session-servers with the SHM-classic (ipc::shm::clas...">ipc::session::shm::classic</a></code>, then you get total read/write abilities and maximized object lifetime. That is the SHM-classic provider. Instead, if you choose SHM-jemalloc (<code>using ssn = <a class="el" href="namespaceipc_1_1session_1_1shm_1_1arena__lend_1_1jemalloc.html" title="Support for SHM-backed ipc::session sessions and session-servers with the SHM-jemalloc (ipc::shm::are...">ipc::session::shm::arena_lend::jemalloc</a></code>), then the borrower (receiver) process can only read, and there are some subtle differences in max object lifetime. (The latter applies only if you need objects to live beyond a given <code>Session</code>.) However, you get in return: superior safety characteristics; and the commercial-grade jemalloc allocation algorithm (thread-caching, fragmentation avoidance, and more).</p>
658658
<h2>Safety </h2>
@@ -683,7 +683,7 @@ <h2>Safety </h2>
683683
</div><!-- PageDoc -->
684684
<!-- start footer part -->
685685
<hr class="footer"/><address class="footer"><small>
686-
Generated on Thu Dec 12 2024 06:10:33 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
686+
Generated on Sat Dec 21 2024 00:38:32 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
687687
</small></address>
688688
</body>
689689
</html>

doc/flow-ipc/versions/main/generated/html_full/app_8cpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
</div><!-- contents -->
113113
<!-- start footer part -->
114114
<hr class="footer"/><address class="footer"><small>
115-
Generated on Thu Dec 12 2024 06:10:33 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
115+
Generated on Sat Dec 21 2024 00:38:32 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
116116
</small></address>
117117
</body>
118118
</html>

doc/flow-ipc/versions/main/generated/html_full/app_8cpp_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@
235235
</div><!-- fragment --></div><!-- contents -->
236236
<!-- start footer part -->
237237
<hr class="footer"/><address class="footer"><small>
238-
Generated on Thu Dec 12 2024 06:10:33 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
238+
Generated on Sat Dec 21 2024 00:38:32 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
239239
</small></address>
240240
</body>
241241
</html>

doc/flow-ipc/versions/main/generated/html_full/app_8hpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
</div><!-- contents -->
103103
<!-- start footer part -->
104104
<hr class="footer"/><address class="footer"><small>
105-
Generated on Thu Dec 12 2024 06:10:33 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
105+
Generated on Sat Dec 21 2024 00:38:32 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
106106
</small></address>
107107
</body>
108108
</html>

doc/flow-ipc/versions/main/generated/html_full/app_8hpp_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@
383383
</div><!-- fragment --></div><!-- contents -->
384384
<!-- start footer part -->
385385
<hr class="footer"/><address class="footer"><small>
386-
Generated on Thu Dec 12 2024 06:10:33 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
386+
Generated on Sat Dec 21 2024 00:38:32 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
387387
</small></address>
388388
</body>
389389
</html>

doc/flow-ipc/versions/main/generated/html_full/arena__activator_8hpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
</div><!-- contents -->
9999
<!-- start footer part -->
100100
<hr class="footer"/><address class="footer"><small>
101-
Generated on Thu Dec 12 2024 06:10:33 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
101+
Generated on Sat Dec 21 2024 00:38:32 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
102102
</small></address>
103103
</body>
104104
</html>

doc/flow-ipc/versions/main/generated/html_full/arena__activator_8hpp_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@
193193
</div><!-- fragment --></div><!-- contents -->
194194
<!-- start footer part -->
195195
<hr class="footer"/><address class="footer"><small>
196-
Generated on Thu Dec 12 2024 06:10:33 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
196+
Generated on Sat Dec 21 2024 00:38:32 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
197197
</small></address>
198198
</body>
199199
</html>

doc/flow-ipc/versions/main/generated/html_full/arena__lend_2src_2ipc_2session_2detail_2shm_2arena__lend_2jemalloc_2session__impl_8hpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#af246ab80f7fcbde0ef7185b1
169169
</div><!-- contents -->
170170
<!-- start footer part -->
171171
<hr class="footer"/><address class="footer"><small>
172-
Generated on Thu Dec 12 2024 06:10:33 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
172+
Generated on Sat Dec 21 2024 00:38:32 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
173173
</small></address>
174174
</body>
175175
</html>

0 commit comments

Comments
 (0)