bitcoin-s/api/routerrpc/PaymentState$.html

14 lines
59 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_.routerrpc" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="routerrpc" class="anchorToMember"></a><a id="routerrpc:routerrpc" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/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">routerrpc</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="current-entities indented1"><a href="BuildRouteRequest$.html" title="" class="object"></a> <a href="BuildRouteRequest.html" title="" class="class"></a><a href="BuildRouteRequest.html" title="">BuildRouteRequest</a></li><li class="current-entities indented1"><a href="BuildRouteResponse$.html" title="" class="object"></a> <a href="BuildRouteResponse.html" title="" class="class"></a><a href="BuildRouteResponse.html" title="">BuildRouteResponse</a></li><li class="current-entities indented1"><a href="ChanStatusAction$.html" title="" class="object"></a> <a href="ChanStatusAction.html" title="" class="class"></a><a href="ChanStatusAction.html" title="">ChanStatusAction</a></li><li class="current-entities indented1"><a href="CircuitKey$.html" title="" class="object"></a> <a href="CircuitKey.html" title="" class="class"></a><a href="CircuitKey.html" title="">CircuitKey</a></li><li class="current-entities indented1"><a href="DefaultRouterClient$.html" title="" class="object"></a> <a href="DefaultRouterClient.html" title="" class="class"></a><a href="DefaultRouterClient.html" title="">DefaultRouterClient</a></li><li class="current-entities indented1"><a href="FailureDetail$.html" title="" class="object"></a> <a href="FailureDetail.html" title="" class="class"></a><a href="FailureDetail.html" title="">FailureDetail</a></li><li class="current-entities indented1"><a href="ForwardEvent$.html" title="" class="object"></a> <a href="ForwardEvent.html" title="" class="class"></a><a href="ForwardEvent.html" title="">ForwardEvent</a></li><li class="current-entities indented1"><a href="ForwardFailEvent$.html" title="" class="object"></a> <a href="ForwardFailEvent.html" title="" class="class"></a><a href="ForwardFailEvent.html" title="">ForwardFailEvent</a></li><li class="current-entities indented1"><a href="ForwardHtlcInterceptRequest$.html" ti
</p></div><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="routerrpc.PaymentState.FAILED_INCORRECT_PAYMENT_DETAILS" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FAILED_INCORRECT_PAYMENT_DETAILS" class="anchorToMember"></a><a id="FAILED_INCORRECT_PAYMENT_DETAILS:FAILED_INCORRECT_PAYMENT_DETAILS" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PaymentState$$FAILED_INCORRECT_PAYMENT_DETAILS$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case object</span></span> <span class="symbol"><a href="PaymentState$$FAILED_INCORRECT_PAYMENT_DETAILS$.html" title="Payment details incorrect (unknown hash, invalid amt or invalid final cltv delta)"><span class="name">FAILED_INCORRECT_PAYMENT_DETAILS</span></a><span class="result"> extends <a href="PaymentState.html" name="routerrpc.PaymentState" id="routerrpc.PaymentState" class="extype">PaymentState</a> with <a href="PaymentState$$Recognized.html" name="routerrpc.PaymentState.Recognized" id="routerrpc.PaymentState.Recognized" class="extype">Recognized</a> 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><p class="shortcomment cmt">Payment details incorrect (unknown hash, invalid amt or
invalid final cltv delta)
</p><div class="fullcomment"><div class="comment cmt"><p>Payment details incorrect (unknown hash, invalid amt or
invalid final cltv delta)
</p></div><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="routerrpc.PaymentState.FAILED_INSUFFICIENT_BALANCE" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FAILED_INSUFFICIENT_BALANCE" class="anchorToMember"></a><a id="FAILED_INSUFFICIENT_BALANCE:FAILED_INSUFFICIENT_BALANCE" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PaymentState$$FAILED_INSUFFICIENT_BALANCE$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case object</span></span> <span class="symbol"><a href="PaymentState$$FAILED_INSUFFICIENT_BALANCE$.html" title="Insufficient local balance."><span class="name">FAILED_INSUFFICIENT_BALANCE</span></a><span class="result"> extends <a href="PaymentState.html" name="routerrpc.PaymentState" id="routerrpc.PaymentState" class="extype">PaymentState</a> with <a href="PaymentState$$Recognized.html" name="routerrpc.PaymentState.Recognized" id="routerrpc.PaymentState.Recognized" class="extype">Recognized</a> 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><p class="shortcomment cmt">Insufficient local balance.</p><div class="fullcomment"><div class="comment cmt"><p>Insufficient local balance.
</p></div><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="routerrpc.PaymentState.FAILED_NO_ROUTE" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FAILED_NO_ROUTE" class="anchorToMember"></a><a id="FAILED_NO_ROUTE:FAILED_NO_ROUTE" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PaymentState$$FAILED_NO_ROUTE$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case object</span></span> <span class="symbol"><a href="PaymentState$$FAILED_NO_ROUTE$.html" title="All possible routes were tried and failed permanently."><span class="name">FAILED_NO_ROUTE</span></a><span class="result"> extends <a href="PaymentState.html" name="routerrpc.PaymentState" id="routerrpc.PaymentState" class="extype">PaymentState</a> with <a href="PaymentState$$Recognized.html" name="routerrpc.PaymentState.Recognized" id="routerrpc.PaymentState.Recognized" class="extype">Recognized</a> 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><p class="shortcomment cmt">All possible routes were tried and failed permanently.</p><div class="fullcomment"><div class="comment cmt"><p>All possible routes were tried and failed permanently. Or were no
routes to the destination at all.
</p></div><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="routerrpc.PaymentState.FAILED_TIMEOUT" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="FAILED_TIMEOUT" class="anchorToMember"></a><a id="FAILED_TIMEOUT:FAILED_TIMEOUT" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PaymentState$$FAILED_TIMEOUT$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case object</span></span> <span class="symbol"><a href="PaymentState$$FAILED_TIMEOUT$.html" title="There are more routes to try, but the payment timeout was exceeded."><span class="name">FAILED_TIMEOUT</span></a><span class="result"> extends <a href="PaymentState.html" name="routerrpc.PaymentState" id="routerrpc.PaymentState" class="extype">PaymentState</a> with <a href="PaymentState$$Recognized.html" name="routerrpc.PaymentState.Recognized" id="routerrpc.PaymentState.Recognized" class="extype">Recognized</a> 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><p class="shortcomment cmt">There are more routes to try, but the payment timeout was exceeded.</p><div class="fullcomment"><div class="comment cmt"><p>There are more routes to try, but the payment timeout was exceeded.
</p></div><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="routerrpc.PaymentState.IN_FLIGHT" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="IN_FLIGHT" class="anchorToMember"></a><a id="IN_FLIGHT:IN_FLIGHT" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PaymentState$$IN_FLIGHT$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case object</span></span> <span class="symbol"><a href="PaymentState$$IN_FLIGHT$.html" title="Payment is still in flight."><span class="name">IN_FLIGHT</span></a><span class="result"> extends <a href="PaymentState.html" name="routerrpc.PaymentState" id="routerrpc.PaymentState" class="extype">PaymentState</a> with <a href="PaymentState$$Recognized.html" name="routerrpc.PaymentState.Recognized" id="routerrpc.PaymentState.Recognized" class="extype">Recognized</a> 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><p class="shortcomment cmt">Payment is still in flight.</p><div class="fullcomment"><div class="comment cmt"><p>Payment is still in flight.
</p></div><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="routerrpc.PaymentState.SUCCEEDED" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SUCCEEDED" class="anchorToMember"></a><a id="SUCCEEDED:SUCCEEDED" class="anchorToMember"></a> <span class="permalink"><a href="../routerrpc/PaymentState$$SUCCEEDED$.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">case object</span></span> <span class="symbol"><a href="PaymentState$$SUCCEEDED$.html" title="Payment completed successfully."><span class="name">SUCCEEDED</span></a><span class="result"> extends <a href="PaymentState.html" name="routerrpc.PaymentState" id="routerrpc.PaymentState" class="extype">PaymentState</a> with <a href="PaymentState$$Recognized.html" name="routerrpc.PaymentState.Recognized" id="routerrpc.PaymentState.Recognized" class="extype">Recognized</a> 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><p class="shortcomment cmt">Payment completed successfully.</p><div class="fullcomment"><div class="comment cmt"><p>Payment completed successfully.
</p></div><dl class="attributes block"><dt>Annotations</dt><dd><span class="name">@SerialVersionUID</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="scalapb.GeneratedEnumCompanion" class="parent"><h3>Inherited from <a href="https://javadoc.io/page/com.thesamet.scalapb/scalapb-runtime_2.13/0.11.10/scalapb/GeneratedEnumCompanion.html#scalapb.GeneratedEnumCompanion" name="scalapb.GeneratedEnumCompanion" id="scalapb.GeneratedEnumCompanion" class="extype">GeneratedEnumCompanion</a>[<a href="PaymentState.html" name="routerrpc.PaymentState" id="routerrpc.PaymentState" class="extype">PaymentState</a>]</h3></div><div name="java.io.Serializable" class="parent"><h3>Inherited from <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java/io/Serializable.html#java.io.Serializable" name="java.io.Serializable" id="java.io.Serializable" class="extype">Serializable</a></h3></div><div name="scala.AnyRef" class="parent"><h3>Inherited from <a href="../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a></h3></div><div name="scala.Any" class="parent"><h3>Inherited from <a href="https://www.scala-lang.org/api/2.13.8/scala/Any.html#scala.Any" name="scala.Any" id="scala.Any" class="extype">Any</a></h3></div></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>