aboutsummaryrefslogtreecommitdiff
path: root/src/interfaces/README.md
diff options
context:
space:
mode:
authorRussell Yanofsky <russ@yanofsky.org>2018-04-07 03:42:02 -0400
committerRussell Yanofsky <russ@yanofsky.org>2018-04-07 03:42:02 -0400
commit17780d6f35a3951f649c3b7766b9283d9c18e39f (patch)
treec858c2d92b028d96118983415f40da5b3a0c48e6 /src/interfaces/README.md
parent5f0c6a7b0e47e03f848dc992d37fe209dd9c6975 (diff)
downloadbitcoin-17780d6f35a3951f649c3b7766b9283d9c18e39f.tar.xz
scripted-diff: Avoid `interface` keyword to fix windows gitian build
Rename `interface` to `interfaces` Build failure reported by Chun Kuan Lee <ken2812221@gmail.com> https://github.com/bitcoin/bitcoin/pull/10244#issuecomment-379434756 -BEGIN VERIFY SCRIPT- git mv src/interface src/interfaces ren() { git grep -l "$1" | xargs sed -i "s,$1,$2,g"; } ren interface/ interfaces/ ren interface:: interfaces:: ren BITCOIN_INTERFACE_ BITCOIN_INTERFACES_ ren "namespace interface" "namespace interfaces" -END VERIFY SCRIPT-
Diffstat (limited to 'src/interfaces/README.md')
-rw-r--r--src/interfaces/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/interfaces/README.md b/src/interfaces/README.md
new file mode 100644
index 0000000000..e93b91d23c
--- /dev/null
+++ b/src/interfaces/README.md
@@ -0,0 +1,17 @@
+# Internal c++ interfaces
+
+The following interfaces are defined here:
+
+* [`Chain`](chain.h) — used by wallet to access blockchain and mempool state. Added in [#10973](https://github.com/bitcoin/bitcoin/pull/10973).
+
+* [`Chain::Client`](chain.h) — used by node to start & stop `Chain` clients. Added in [#10973](https://github.com/bitcoin/bitcoin/pull/10973).
+
+* [`Node`](node.h) — used by GUI to start & stop bitcoin node. Added in [#10244](https://github.com/bitcoin/bitcoin/pull/10244).
+
+* [`Wallet`](wallet.h) — used by GUI to access wallets. Added in [#10244](https://github.com/bitcoin/bitcoin/pull/10244).
+
+* [`Handler`](handler.h) — returned by `handleEvent` methods on interfaces above and used to manage lifetimes of event handlers.
+
+* [`Init`](init.h) — used by multiprocess code to access interfaces above on startup. Added in [#10102](https://github.com/bitcoin/bitcoin/pull/10102).
+
+The interfaces above define boundaries between major components of bitcoin code (node, wallet, and gui), making it possible for them to run in different processes, and be tested, developed, and understood independently. These interfaces are not currently designed to be stable or to be used externally.