Flow-IPC is a comprehensive C++ toolkit for latency-free interprocess communication. This site contains documentation and release links.
This site hosts up-to-date documentation and release info for the Flow-IPC project. The documentation found here is identical to that packaged in Flow-IPC and Flow release packages and source-control checkouts.
The project lives in the Flow-IPC
organization at GitHub. You can obtain it either via Git checkout (with submodules enabled) or by grabbing a release package. To get your bearings as to the nature of the project please see the main repository, named ipc
. To wit:
The README in that repo is a good place to start. It might direct you back to this site, if you’d like to read online documentation and/or peruse or obtain a particular version of the product. Those resources can be found below. So to summarize:
ipc
repo) linked here.Here is the Flow-IPC online documentation for your immediate perusal (plus release links):
main
tip: documentationNote: If you have a Flow-IPC release package (from above), you do not need a Flow package (from below): it’s already included. The online Flow documentation links and release notes may be of interest, though.
Here is the Flow online documentation for your immediate perusal (plus release links):
main
tip: documentationOr you can locally view the same documentation by pointing your browser at the below-mentioned locations in your checkout or unpacked package. Or, upon clicking on a CI/CD pipeline run for Flow-IPC or Flow, you can download the artifact named ipc-doc
or flow-doc
, respectively. It is a tarball containing the documentation; unpack it and point your browser at the result.
Such documentation is generated directly from the source code automatically and is stored as follows:
ipc
in the doc/ipc_doc/
directory;
ipc
: in the flow/doc/flow_doc/
directory;flow
: in the doc/flow_doc/
directory;Both sets of documentation (in-repo and online) are generated/deployed automatically:
main
branch of ipc
or flow
is updated, thus changing the source code of Flow-IPC or Flow respectively;main
branch of ipc
or flow
is tagged to mark a new release (e.g., v1.2.3
) of Flow-IPC or Flow respectively.