-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(Commit by workflow script) Update generated documentation.
- Loading branch information
github-actions
committed
Jan 10, 2024
1 parent
90c96ef
commit d37539c
Showing
4,696 changed files
with
439,654 additions
and
0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> | ||
| <meta name="generator" content="Doxygen 1.9.4"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>Flow-IPC: (Manual Start) Flow-IPC: Bird's-eye View</title> | ||
| <link href="tabs.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="jquery.js"></script> | ||
| <script type="text/javascript" src="dynsections.js"></script> | ||
| <link href="search/search.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="search/searchdata.js"></script> | ||
| <script type="text/javascript" src="search/search.js"></script> | ||
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
| </head> | ||
| <body> | ||
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> | ||
| <div id="titlearea"> | ||
| <table cellspacing="0" cellpadding="0"> | ||
| <tbody> | ||
| <tr id="projectrow"> | ||
| <td id="projectalign"> | ||
| <div id="projectname">Flow-IPC<span id="projectnumber"> 1.0</span> | ||
| </div> | ||
| <div id="projectbrief">Flow-IPC project: Full implementation reference.</div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.4 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| var searchBox = new SearchBox("searchBox", "search",'Search','.html'); | ||
| /* @license-end */ | ||
| </script> | ||
| <script type="text/javascript" src="menudata.js"></script> | ||
| <script type="text/javascript" src="menu.js"></script> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(function() { | ||
| initMenu('',true,false,'search.php','Search'); | ||
| $(document).ready(function() { init_search(); }); | ||
| }); | ||
| /* @license-end */ | ||
| </script> | ||
| <div id="main-nav"></div> | ||
| <!-- window showing the filter options --> | ||
| <div id="MSearchSelectWindow" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
| </div> | ||
|
|
||
| <!-- iframe showing the search results (closed by default) --> | ||
| <div id="MSearchResultsWindow"> | ||
| <iframe src="javascript:void(0)" frameborder="0" | ||
| name="MSearchResults" id="MSearchResults"> | ||
| </iframe> | ||
| </div> | ||
|
|
||
| </div><!-- top --> | ||
| <div><div class="header"> | ||
| <div class="headertitle"><div class="title">(Manual Start) Flow-IPC: Bird's-eye View </div></div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
| <div class="textblock"><center><b>MANUAL NAVIGATION:</b> <a class="el" href="api_overview.html">Next Page</a> - <a href="./pages.html"><b>Table of Contents</b></a></center><hr /> | ||
| <p ><a class="anchor" id="fig0"></a></p><div class="image"> | ||
| <img src="sessions_and_transport_high_v2.png" alt=""/> | ||
| </div> | ||
| <ul> | ||
| <li>On the left – Flow-IPC's mission: applications speaking to each other performantly, in organized fashion.</li> | ||
| <li>On the right – zooming into a single communication channel; and how it transmits data of various kinds without copying (therefore at high speed).</li> | ||
| </ul> | ||
| <p >We hope a picture is worth a thousand words, but please do scroll down to read a few words anyway.</p> | ||
| <h2>Executive summary: Why does Flow-IPC exist? </h2> | ||
| <p >Multi-process microservice systems need to communicate between processes efficiently. Existing microservice communication frameworks are elegant at a high level but add unacceptable latency out of the box. Low-level interprocess communication (<em>IPC</em>) solutions, typically custom-written on-demand to address this problem, struggle to do so comprehensively and in reusable fashion. Teams repeatedly spend resources on challenges like structured data and session cleanup. These issues make it difficult to break monolithic systems into more resilient multi-process systems that are also performant.</p> | ||
| <p >Flow-IPC is a modern C++ library that solves these problems. It adds virtually zero latency. Structured data are represented using the high-speed Cap’n Proto (<em>capnp</em>) serialization library, which is integrated directly into our shared memory (SHM) system. The Flow-IPC SHM system extends a commercial-grade memory manager (<em>jemalloc</em>, as used by FreeBSD and Meta). Overall, this approach eliminates all memory copying (end-to-end <em>zero copy</em>).</p> | ||
| <p >Flow-IPC features a session-based channel management model. A <em>session</em> is a conversation between two programs; to start talking one only needs the name of the other program. Resource cleanup, in case of exit or failure of either program, is automatic. Flow-IPC’s sessions are also safety-minded as to the identities and permissions at both ends of the conversation.</p> | ||
| <p >Flow-IPC’s API allows developers to easily adapt existing code to a multi-process model. Instead of each dev team writing their own IPC implementation piecemeal, Flow-IPC provides a highly efficient standard that can be used across many projects.</p> | ||
| <hr /> | ||
| <p >Welcome to the guided Manual. It explains how to use Flow-IPC with a gentle learning curve in mind. It is arranged in top-down order. (You may also be interested in the <a class="el" href="namespaceipc.html">Reference</a>.)</p> | ||
| <h2>Feature overview: What is Flow-IPC? </h2> | ||
| <p >Flow-IPC:</p><ul> | ||
| <li>is a <b>modern C++</b> library with a concept-based API in the spirit of STL/Boost;</li> | ||
| <li>enables near-zero-latency <b>zero-copy</b> messaging between processes (via behind-the-scenes use of the below SHM solution);</li> | ||
| <li>transmits messages containing binary data, native handles, and/or <b>structured data</b> (defined via <a href="https://capnproto.org/language.html">Cap'n Proto</a>);</li> | ||
| <li>provides a <b>shared memory (SHM)</b> solution<ul> | ||
| <li>with out-of-the-box ability to transmit arbitrarily complex combinations of scalars, <code>struct</code>s, and <b>STL-compliant containers</b> thereof;</li> | ||
| <li>that integrates with <b>commercial-grade memory managers</b> (a/k/a <code>malloc()</code> providers).<ul> | ||
| <li>In particular we integrate with <a href="https://jemalloc.net">jemalloc</a>, a thread-caching memory manager at the core of FreeBSD, Meta, and others.</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <p >A key feature of Flow-IPC is pain-free setup of process-to-process conversations (<b>sessions</b>), so that users need not worry about coordinating individual shared-resource naming between processes, not to mention kernel-persistent resource cleanup.</p> | ||
| <p >Flow-IPC provides 2 ways to integrate with your applications' event loops. These can be intermixed.</p><ul> | ||
| <li>The <b>async-I/O API</b> automatically starts threads as needed to offload work onto multi-processor cores.</li> | ||
| <li>The <code>sync_io</code> <b>API</b> supplies lighter-weight objects allowing you full control over each application's thread structure, hooking into reactor-style (<code>poll()</code>, <code>epoll_wait()</code>, etc.) or proactor (boost.asio) event loops. As a result context switching is minimized.</li> | ||
| </ul> | ||
| <p >Lastly Flow-IPC supplies <b>lower-level utilities</b> facilitating work with POSIX and SHM-based <b>message queues (MQs)</b> and <b>local (Unix domain) stream sockets</b>.</p> | ||
| <hr /> | ||
| <p >The high-level diagram <a class="el" href="about.html#fig0">above</a> is a pretty good synopsis of the highest-impact features. The following diagram delves deeper, roughly introducing the <em>core</em> layer of <a class="el" href="namespaceipc_1_1transport.html" title="Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) betwe...">ipc::transport</a>. Then we begin a textual exploration in <a class="el" href="api_overview.html">API Overview</a>.</p> | ||
| <div class="image"> | ||
| <img src="1x1.png" alt=""/> | ||
| <div class="caption"> | ||
| Figure 1. IPC channels (core layer); SHM arenas; and your code.</div></div> | ||
| <div class="image"> | ||
| <img src="transport_core_v1.png" alt=""/> | ||
| </div> | ||
| <hr /> | ||
| <center><b>MANUAL NAVIGATION:</b> <a class="el" href="api_overview.html">Next Page</a> - <a href="./pages.html"><b>Table of Contents</b></a></center> </div></div><!-- contents --> | ||
| </div><!-- PageDoc --> | ||
| <!-- start footer part --> | ||
| <hr class="footer"/><address class="footer"><small> | ||
| Generated on Wed Jan 10 2024 06:41:49 for Flow-IPC by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 | ||
| </small></address> | ||
| </body> | ||
| </html> |
Oops, something went wrong.