bitcoin-s/api/org/bitcoins/node/index.html

8 lines
56 KiB
HTML
Raw Normal View History

<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title></title><meta content="" name="description"/><meta content="" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../lib/index.js"></script><script type="text/javascript" src="../../../index.js"></script><script type="text/javascript" src="../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
var toRoot = '../../../';</script></head><body><div id="search"><span id="doc-title"><span id="doc-version"></span></span> <span class="close-results"><span class="left">&lt;</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_" class="anchorToMember"></a><a id="root:_root_" class="anchorToMember"></a> <span class="permalink"><a href="../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.org" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="org" class="anchorToMember"></a><a id="org:org" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">org</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="org.bitcoins" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="bitcoins" class="anchorToMember"></a><a id="bitcoins:bitcoins" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">bitcoins</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="org" id="org" class="extype">org</a></dd></dl></div></li><li class="indented3 " name="org.bitcoins.asyncutil" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asyncutil" class="anchorToMember"></a><a id="asyncutil:asyncutil" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/asyncutil/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../asyncutil/index.html" title=""><span class="name">asyncutil</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="org.bitcoins" id="org.bitcoins" class="extype">bitcoins</a></dd></dl></div></li><li class="indented3 " name="org.bitcoins.bench" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="bench" class="anchorToMember"></a><a id="bench:bench" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/bench/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class=
</p></div></div></li><li class="indented0 " name="org.bitcoins.node.NodeCallbacks" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="NodeCallbacksextendsAnyRef" class="anchorToMember"></a><a id="NodeCallbacks:NodeCallbacks" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/node/NodeCallbacks.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="NodeCallbacks.html" title="Callbacks for responding to events in the node."><span class="name">NodeCallbacks</span></a><span class="result"> extends <a href="../../../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></span></span><p class="shortcomment cmt">Callbacks for responding to events in the node.</p><div class="fullcomment"><div class="comment cmt"><p>Callbacks for responding to events in the node.
The appropriate callback is executed whenever the node receives
a <code>getdata</code> message matching it.
</p></div></div></li><li class="indented0 " name="org.bitcoins.node.OnBlockHeadersReceived" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="OnBlockHeadersReceivedextendsCallback[Vector[org.bitcoins.core.protocol.blockchain.BlockHeader]]" class="anchorToMember"></a><a id="OnBlockHeadersReceived:OnBlockHeadersReceived" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/node/OnBlockHeadersReceived.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="OnBlockHeadersReceived.html" title="Callback for handling a received block header"><span class="name">OnBlockHeadersReceived</span></a><span class="result"> extends <a href="../core/api/Callback.html" name="org.bitcoins.core.api.Callback" id="org.bitcoins.core.api.Callback" class="extype">Callback</a>[<a href="../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="../core/protocol/blockchain/BlockHeader.html" name="org.bitcoins.core.protocol.blockchain.BlockHeader" id="org.bitcoins.core.protocol.blockchain.BlockHeader" class="extype">BlockHeader</a>]]</span></span><p class="shortcomment cmt">Callback for handling a received block header</p></li><li class="indented0 " name="org.bitcoins.node.OnBlockReceived" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="OnBlockReceivedextendsCallback[org.bitcoins.core.protocol.blockchain.Block]" class="anchorToMember"></a><a id="OnBlockReceived:OnBlockReceived" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/node/OnBlockReceived.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="OnBlockReceived.html" title="Callback for handling a received block"><span class="name">OnBlockReceived</span></a><span class="result"> extends <a href="../core/api/Callback.html" name="org.bitcoins.core.api.Callback" id="org.bitcoins.core.api.Callback" class="extype">Callback</a>[<a href="../core/protocol/blockchain/Block.html" name="org.bitcoins.core.protocol.blockchain.Block" id="org.bitcoins.core.protocol.blockchain.Block" class="extype">Block</a>]</span></span><p class="shortcomment cmt">Callback for handling a received block</p></li><li class="indented0 " name="org.bitcoins.node.OnCompactFiltersReceived" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="OnCompactFiltersReceivedextendsCallback[Vector[(org.bitcoins.crypto.DoubleSha256Digest,org.bitcoins.core.gcs.GolombFilter)]]" class="anchorToMember"></a><a id="OnCompactFiltersReceived:OnCompactFiltersReceived" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/node/OnCompactFiltersReceived.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">trait</span></span> <span class="symbol"><a href="OnCompactFiltersReceived.html" title="Callback for handling a received compact block filter"><span class="name">OnCompactFiltersReceived</span></a><span class="result"> extends <a href="../core/api/Callback.html" name="org.bitcoins.core.api.Callback" id="org.bitcoins.core.api.Callback" class="extype">Callback</a>[<a href="../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[(<a href="../crypto/DoubleSha256Digest.html" name="org.bitcoins.crypto.DoubleSha256Digest" id="org.bitcoins.crypto.DoubleSha256Digest" class="extype">DoubleSha256Digest</a>, <a href="../core/gcs/GolombFilter.html" name="org.bitcoins.core.gcs.GolombFilter" id="org.bitcoins.core.gcs.GolombFilter" class="extype">GolombFilter</a>)]]</span></span><p class="shortcomment cmt">Callback for handling a received compact block filter</p></li><li class
</p></li><li class="indented0 " name="org.bitcoins.node.PeerManager" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="PeerManagerextendsP2PLoggerwithProductwithSerializable" class="anchorToMember"></a><a id="PeerManager:PeerManager" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/node/PeerManager.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case class</span></span> <span class="symbol"><a href="PeerManager.html" title=""><span class="name">PeerManager</span></a><span class="params">(<span name="node">node: <a href="Node.html" name="org.bitcoins.node.Node" id="org.bitcoins.node.Node" class="extype">Node</a></span>, <span name="configPeers">configPeers: <a href="../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="models/Peer.html" name="org.bitcoins.node.models.Peer" id="org.bitcoins.node.models.Peer" class="extype">Peer</a>] = <span class="symbol"><span class="name"><a href="../../../scala/index.html">Vector.empty</a></span></span></span>)</span><span class="params">(<span class="implicit">implicit </span><span name="ec">ec: <a href="https://www.scala-lang.org/api/2.13.8/scala/concurrent/ExecutionContext.html#scala.concurrent.ExecutionContext" name="scala.concurrent.ExecutionContext" id="scala.concurrent.ExecutionContext" class="extype">ExecutionContext</a></span>, <span name="system">system: <a href="https://doc.akka.io/api/akka/2.6.19/akka/actor/ActorSystem.html#akka.actor.ActorSystem" name="akka.actor.ActorSystem" id="akka.actor.ActorSystem" class="extype">ActorSystem</a></span>, <span name="nodeAppConfig">nodeAppConfig: <a href="config/NodeAppConfig.html" name="org.bitcoins.node.config.NodeAppConfig" id="org.bitcoins.node.config.NodeAppConfig" class="extype">NodeAppConfig</a></span>)</span><span class="result"> extends <span name="org.bitcoins.node.P2PLogger" class="extype">P2PLogger</span> with <a href="https://www.scala-lang.org/api/2.13.8/scala/Product.html#scala.Product" name="scala.Product" id="scala.Product" class="extype">Product</a> with <a href="../../../scala/index.html#Serializable=java.io.Serializable" name="scala.Serializable" id="scala.Serializable" class="extmbr">Serializable</a></span></span></li><li class="indented0 " name="org.bitcoins.node.SpvNode" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="SpvNodeextendsNodewithProductwithSerializable" class="anchorToMember"></a><a id="SpvNode:SpvNode" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/node/SpvNode.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case class</span></span> <span class="symbol"><a href="SpvNode.html" title=""><span class="name">SpvNode</span></a><span class="params">(<span name="dataMessageHandler">dataMessageHandler: <a href="networking/peer/DataMessageHandler.html" name="org.bitcoins.node.networking.peer.DataMessageHandler" id="org.bitcoins.node.networking.peer.DataMessageHandler" class="extype">DataMessageHandler</a></span>, <span name="nodeConfig">nodeConfig: <a href="config/NodeAppConfig.html" name="org.bitcoins.node.config.NodeAppConfig" id="org.bitcoins.node.config.NodeAppConfig" class="extype">NodeAppConfig</a></span>, <span name="chainConfig">chainConfig: <a href="../chain/config/ChainAppConfig.html" name="org.bitcoins.chain.config.ChainAppConfig" id="org.bitcoins.chain.config.ChainAppConfig" class="extype">ChainAppConfig</a></span>, <span name="actorSystem">actorSystem: <a href="https://doc.akka.io/api/akka/2.6.19/akka/actor/ActorSystem.html#akka.actor.ActorSystem" name="akka.actor.ActorSystem" id="akka.actor.ActorSystem" class="extype">ActorSystem</a></span>, <span name="configPeersOverride">configPeersOverride: <a href="../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector"