bitcoin-s/api/peersrpc/index.html

14 lines
34 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 current" name="_root_.peersrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="peersrpc" class="anchorToMember"></a><a id="peersrpc:peersrpc" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/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"><span class="name">peersrpc</span></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="current-entities indented1"><a href="FeatureSet$.html" title="" class="object"></a> <a href="FeatureSet.html" title="" class="class"></a><a href="FeatureSet.html" title="">FeatureSet</a></li><li class="current-entities indented1"><a href="NodeAnnouncementUpdateRequest$.html" title="" class="object"></a> <a href="NodeAnnouncementUpdateRequest.html" title="" class="class"></a><a href="NodeAnnouncementUpdateRequest.html" title="">NodeAnnouncementUpdateRequest</a></li><li class="current-entities indented1"><a href="NodeAnnouncementUpdateResponse$.html" title="" class="object"></a> <a href="NodeAnnouncementUpdateResponse.html" title="" class="class"></a><a href="NodeAnnouncementUpdateResponse.html" title="">NodeAnnouncementUpdateResponse</a></li><li class="current-entities indented1"><a href="Peers$.html" title="" class="object"></a> <a href="Peers.html" title="Peers is a service that can be used to get information and interact with the other nodes of the network." class="trait"></a><a href="Peers.html" title="Peers is a service that can be used to get information and interact with the other nodes of the network.">Peers</a></li><li class="current-entities indented1"><a href="PeersClient$.html" title="" class="object"></a> <a href="PeersClient.html" title="" class="trait"></a><a href="PeersClient.html" title="">PeersClient</a></li><li class="current-entities indented1"><span class="separator"></span> <a href="PeersClientPowerApi.html" title="" class="trait"></a><a href="PeersClientPowerApi.html" title="">PeersClientPowerApi</a></li><li class="current-entities indented1"><span class="separator"></span> <a href="PeersHandler$.html" title="" class="object"></a><a href="PeersHandler$.html" title="">PeersHandler</a></li><li class="current-entities indented1"><span class="separator"></span> <a href="PeersProto$.html" title="" class="object"></a><a href="PeersProto$.h
Set of changes for the features that the node supports.</p></dd><dt class="param">color</dt><dd class="cmt"><p>
Color is the node's color in hex code format.</p></dd><dt class="param">alias</dt><dd class="cmt"><p>
Alias or nick name of the node.</p></dd><dt class="param">addressUpdates</dt><dd class="cmt"><p>
Set of changes for the node's known addresses.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="peersrpc.NodeAnnouncementUpdateResponse" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="NodeAnnouncementUpdateResponseextendsGeneratedMessagewithUpdatable[peersrpc.NodeAnnouncementUpdateResponse]withProductwithSerializable" class="anchorToMember"></a><a id="NodeAnnouncementUpdateResponse:NodeAnnouncementUpdateResponse" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/NodeAnnouncementUpdateResponse.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="NodeAnnouncementUpdateResponse.html" title=""><span class="name">NodeAnnouncementUpdateResponse</span></a><span class="params">(<span name="ops">ops: <a href="../scala/index.html#Seq[+A]=Seq[A]" name="scala.Seq" id="scala.Seq" class="extmbr">Seq</a>[<a href="../lnrpc/Op.html" name="lnrpc.Op" id="lnrpc.Op" class="extype">Op</a>] = <span class="symbol"><span class="name"><a href="../scala/index.html">_root_.scala.Seq.empty</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="NodeAnnouncementUpdateResponse.html" name="peersrpc.NodeAnnouncementUpdateResponse" id="peersrpc.NodeAnnouncementUpdateResponse" class="extype">NodeAnnouncementUpdateResponse</a>] with <a href="https://www.scala-lang.org/api/2.13.11/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><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="peersrpc.Peers" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="PeersextendsAnyRef" class="anchorToMember"></a><a id="Peers:Peers" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/Peers.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="Peers.html" title="Peers is a service that can be used to get information and interact with the other nodes of the network."><span class="name">Peers</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">Peers is a service that can be used to get information and interact
with the other nodes of the network.</p><div class="fullcomment"><div class="comment cmt"><p>Peers is a service that can be used to get information and interact
with the other nodes of the network.
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="peersrpc.PeersClient" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="PeersClientextendsPeerswithPeersClientPowerApiwithAkkaGrpcClient" class="anchorToMember"></a><a id="PeersClient:PeersClient" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/PeersClient.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="PeersClient.html" title=""><span class="name">PeersClient</span></a><span class="result"> extends <a href="Peers.html" name="peersrpc.Peers" id="peersrpc.Peers" class="extype">Peers</a> with <a href="PeersClientPowerApi.html" name="peersrpc.PeersClientPowerApi" id="peersrpc.PeersClientPowerApi" class="extype">PeersClientPowerApi</a> with <a href="https://doc.akka.io/api/akka-grpc/2.1.6/akka/grpc/akka/grpc/scaladsl/AkkaGrpcClient.html#akka.grpc.scaladsl.AkkaGrpcClient" name="akka.grpc.scaladsl.AkkaGrpcClient" id="akka.grpc.scaladsl.AkkaGrpcClient" class="extype">AkkaGrpcClient</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="peersrpc.PeersClientPowerApi" group="Ungrouped" fullComment="yes" data-isabs="true" visbl="pub"><a id="PeersClientPowerApiextendsAnyRef" class="anchorToMember"></a><a id="PeersClientPowerApi:PeersClientPowerApi" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/PeersClientPowerApi.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="PeersClientPowerApi.html" title=""><span class="name">PeersClientPowerApi</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><div class="fullcomment"><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@AkkaGrpcGenerated</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="peersrpc.UpdateAction" group="Ungrouped" fullComment="no" data-isabs="true" visbl="pub"><a id="UpdateActionextendsGeneratedEnum" class="anchorToMember"></a><a id="UpdateAction:UpdateAction" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/UpdateAction.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">sealed abstract </span> <span class="kind">class</span></span> <span class="symbol"><a href="UpdateAction.html" title="UpdateAction is used to determine the kind of action we are referring to."><span class="name">UpdateAction</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnum.html#scalapb.GeneratedEnum" name="scalapb.GeneratedEnum" id="scalapb.GeneratedEnum" class="extype">GeneratedEnum</a></span></span><p class="shortcomment cmt">UpdateAction is used to determine the kind of action we are referring to.</p></li><li class="indented0 " name="peersrpc.UpdateAddressAction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateAddressActionextendsGeneratedMessagewithUpdatable[peersrpc.UpdateAddressAction]withProductwithSerializable" class="anchorToMember"></a><a id="UpdateAddressAction:UpdateAddressAction" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/UpdateAddressAction.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="UpdateAddressAction.html" title=""><sp
Determines the kind of action.</p></dd><dt class="param">address</dt><dd class="cmt"><p>
The address used to apply the update action.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="peersrpc.UpdateFeatureAction" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateFeatureActionextendsGeneratedMessagewithUpdatable[peersrpc.UpdateFeatureAction]withProductwithSerializable" class="anchorToMember"></a><a id="UpdateFeatureAction:UpdateFeatureAction" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/UpdateFeatureAction.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">case class</span></span> <span class="symbol"><a href="UpdateFeatureAction.html" title=""><span class="name">UpdateFeatureAction</span></a><span class="params">(<span name="action">action: <a href="UpdateAction.html" name="peersrpc.UpdateAction" id="peersrpc.UpdateAction" class="extype">UpdateAction</a> = <span class="symbol"><span class="name"><a href="">peersrpc.UpdateAction.ADD</a></span></span></span>, <span name="featureBit">featureBit: <a href="../lnrpc/FeatureBit.html" name="lnrpc.FeatureBit" id="lnrpc.FeatureBit" class="extype">FeatureBit</a> = <span class="defval"><span class="name"><a href="../lnrpc/index.html">lnrpc.FeatureBit.DATALOSS_PROTECT_REQ</a></span></span></span>, <span name="unknownFields">unknownFields: <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/UnknownFieldSet.html#scalapb.UnknownFieldSet" name="scalapb.UnknownFieldSet" id="scalapb.UnknownFieldSet" class="extype">UnknownFieldSet</a> = <span class="defval">_root_.scalapb.UnknownFieldSet.empty</span></span>)</span><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessage.html#scalapb.GeneratedMessage" name="scalapb.GeneratedMessage" id="scalapb.GeneratedMessage" class="extype">GeneratedMessage</a> with <a href="https://javadoc.io/page/com.thesamet.scalapb/lenses_2.13/0.11.11/scalapb/lenses/Updatable.html#scalapb.lenses.Updatable" name="scalapb.lenses.Updatable" id="scalapb.lenses.Updatable" class="extype">Updatable</a>[<a href="UpdateFeatureAction.html" name="peersrpc.UpdateFeatureAction" id="peersrpc.UpdateFeatureAction" class="extype">UpdateFeatureAction</a>] with <a href="https://www.scala-lang.org/api/2.13.11/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><p class="shortcomment cmt"></p><div class="fullcomment"><div class="comment cmt"></div><dl class="paramcmts block"><dt class="param">action</dt><dd class="cmt"><p>
Determines the kind of action.</p></dd><dt class="param">featureBit</dt><dd class="cmt"><p>
The feature bit used to apply the update action.</p></dd></dl><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="peersrpc.FeatureSet" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="FeatureSet" class="anchorToMember"></a><a id="FeatureSet:FeatureSet" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/FeatureSet$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="FeatureSet$.html" title=""><span class="name">FeatureSet</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedEnumCompanion.html#scalapb.GeneratedEnumCompanion" name="scalapb.GeneratedEnumCompanion" id="scalapb.GeneratedEnumCompanion" class="extype">GeneratedEnumCompanion</a>[<a href="FeatureSet.html" name="peersrpc.FeatureSet" id="peersrpc.FeatureSet" class="extype">FeatureSet</a>]</span></span></li><li class="indented0 " name="peersrpc.NodeAnnouncementUpdateRequest" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="NodeAnnouncementUpdateRequest" class="anchorToMember"></a><a id="NodeAnnouncementUpdateRequest:NodeAnnouncementUpdateRequest" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/NodeAnnouncementUpdateRequest$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="NodeAnnouncementUpdateRequest$.html" title=""><span class="name">NodeAnnouncementUpdateRequest</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="NodeAnnouncementUpdateRequest.html" name="peersrpc.NodeAnnouncementUpdateRequest" id="peersrpc.NodeAnnouncementUpdateRequest" class="extype">NodeAnnouncementUpdateRequest</a>]</span></span></li><li class="indented0 " name="peersrpc.NodeAnnouncementUpdateResponse" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="NodeAnnouncementUpdateResponse" class="anchorToMember"></a><a id="NodeAnnouncementUpdateResponse:NodeAnnouncementUpdateResponse" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/NodeAnnouncementUpdateResponse$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="NodeAnnouncementUpdateResponse$.html" title=""><span class="name">NodeAnnouncementUpdateResponse</span></a><span class="result"> extends <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.11/scalapb/GeneratedMessageCompanion.html#scalapb.GeneratedMessageCompanion" name="scalapb.GeneratedMessageCompanion" id="scalapb.GeneratedMessageCompanion" class="extype">GeneratedMessageCompanion</a>[<a href="NodeAnnouncementUpdateResponse.html" name="peersrpc.NodeAnnouncementUpdateResponse" id="peersrpc.NodeAnnouncementUpdateResponse" class="extype">NodeAnnouncementUpdateResponse</a>]</span></span></li><li class="indented0 " name="peersrpc.Peers" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Peers" class="anchorToMember"></a><a id="Peers:Peers" class="anchorToMember"></a> <span class="permalink"><a href="../peersrpc/Peers$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">object</span></span> <span class="symbol"><a href="Peers$.html"