bitcoin-s/api/org/bitcoins/server/BitcoinSAppConfig$.html

13 lines
90 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.server" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="server" class="anchorToMember"></a><a id="server:server" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/server/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">server</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="indented4 " name="org.bitcoins.server.routes" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="routes" class="anchorToMember"></a><a id="routes:routes" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/server/routes/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"><
to be passed in wherever a specializes one is required
</p></div><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><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>, <a href="https://javadoc.io/page/org.clapper/grizzled-slf4j_2.13/1.3.4/grizzled/slf4j/Logging.html#grizzled.slf4j.Logging" name="grizzled.slf4j.Logging" id="grizzled.slf4j.Logging" class="extype">Logging</a>, <a href="../../../scala/index.html#AnyRef=Object" name="scala.AnyRef" id="scala.AnyRef" class="extmbr">AnyRef</a>, <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></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="org.bitcoins.server.BitcoinSAppConfig"><span>BitcoinSAppConfig</span></li><li class="in" name="java.io.Serializable"><span>Serializable</span></li><li class="in" name="grizzled.slf4j.Logging"><span>Logging</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean" class="anchorToMember"></a><a id="!=(Any):Boolean" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/server/BitcoinSAppConfig$.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <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></span>)</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/Boolean.html#scala.Boolean" name="scala.Boolean" id="scala.Boolean" class="extype">Boolean</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/server/BitcoinSAppConfig$.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <a href="https://www.scala-lang.org/api/2.13.8/scala/Int.html#scala.Int" name="scala.Int" id="scala.Int" class="extype">Int</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl
1.</p><div class="fullcomment"><div class="comment cmt"><p>Resolve BitcoinSAppConfig in the following order of precedence
1. Server args
2. bitcoin-s-bundle.conf
3. bitcoin-s.conf
4. application.conf
5. reference.conf
</p></div></div></li><li class="indented0 " name="org.bitcoins.server.BitcoinSAppConfig#fromDatadirWithServerArgs" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="fromDatadirWithServerArgs(datadir:java.nio.file.Path,serverArgsParser:org.bitcoins.commons.util.ServerArgParser)(implicitsystem:akka.actor.ActorSystem):org.bitcoins.server.BitcoinSAppConfig" class="anchorToMember"></a><a id="fromDatadirWithServerArgs(Path,ServerArgParser)(ActorSystem):BitcoinSAppConfig" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/server/BitcoinSAppConfig$.html#fromDatadirWithServerArgs(datadir:java.nio.file.Path,serverArgsParser:org.bitcoins.commons.util.ServerArgParser)(implicitsystem:akka.actor.ActorSystem):org.bitcoins.server.BitcoinSAppConfig" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">fromDatadirWithServerArgs</span><span class="params">(<span name="datadir">datadir: <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java/nio/file/Path.html#java.nio.file.Path" name="java.nio.file.Path" id="java.nio.file.Path" class="extype">Path</a></span>, <span name="serverArgsParser">serverArgsParser: <a href="../commons/util/ServerArgParser.html" name="org.bitcoins.commons.util.ServerArgParser" id="org.bitcoins.commons.util.ServerArgParser" class="extype">ServerArgParser</a></span>)</span><span class="params">(<span class="implicit">implicit </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><span class="result">: <a href="BitcoinSAppConfig.html" name="org.bitcoins.server.BitcoinSAppConfig" id="org.bitcoins.server.BitcoinSAppConfig" class="extype">BitcoinSAppConfig</a></span></span></li><li class="indented0 " name="org.bitcoins.server.BitcoinSAppConfig#fromDefaultDatadir" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="fromDefaultDatadir(confs:com.typesafe.config.Config*)(implicitsystem:akka.actor.ActorSystem):org.bitcoins.server.BitcoinSAppConfig" class="anchorToMember"></a><a id="fromDefaultDatadir(Config*)(ActorSystem):BitcoinSAppConfig" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/server/BitcoinSAppConfig$.html#fromDefaultDatadir(confs:com.typesafe.config.Config*)(implicitsystem:akka.actor.ActorSystem):org.bitcoins.server.BitcoinSAppConfig" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">fromDefaultDatadir</span><span class="params">(<span name="confs">confs: <a href="https://javadoc.io/page/com.typesafe/config/1.4.2/com/typesafe/config/Config.html#com.typesafe.config.Config" name="com.typesafe.config.Config" id="com.typesafe.config.Config" class="extype">Config</a>*</span>)</span><span class="params">(<span class="implicit">implicit </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><span class="result">: <a href="BitcoinSAppConfig.html" name="org.bitcoins.server.BitcoinSAppConfig" id="org.bitcoins.server.BitcoinSAppConfig" class="extype">BitcoinSAppConfig</a></span></span><p class="shortcomment cmt">Constructs an app configuration from the default Bitcoin-S
data directory and given list of configuration overrides.</p></li><li class="indented0 " name="org.bitcoins.server.BitcoinSAppConfig#fromDefaultDatadirWithBundleConf" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="fromDefaultDatadirWithBundleConf(confs:Vector[com.typesafe.config.Config])(implicitsystem:akka.actor.ActorSystem):org.bitcoins.server.BitcoinSAppConfig" class="anchorToMember"></a><a id="fromDefaultDatadirWithBundleConf(Vector[Config])(ActorSystem):BitcoinSAppConfig" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/server/BitcoinSAppConfig$.html#fromDefaultDatadirWithBundleConf(confs:Vector[com.typesafe.config.Config])(implicitsystem:akka.actor.ActorSystem):org.bitcoins.server.BitcoinSAppConfig" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">fromDefaultDatadirWithBundleConf</span><span class="params">(<span name="confs">confs: <a href="../../../scala/index.html#Vector[+A]=scala.collection.immutable.Vector[A]" name="scala.Vector" id="scala.Vector" class="extmbr">Vector</a>[<a href="https://javadoc.io/page/com.typesafe/config/1.4.2/com/typesafe/config/Config.html#com.typesafe.config.Config" name="com.typesafe.config.Config" id="com.typesafe.config.Config" class="extype">Config</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="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><span class="result">: <a href="BitcoinSAppConfig.html" name="org.bitcoins.server.BitcoinSAppConfig" id="org.bitcoins.server.BitcoinSAppConfig" class="extype">BitcoinSAppConfig</a></span></span></li><li class="indented0 " name="org.bitcoins.server.BitcoinSAppConfig#fromDefaultDatadirWithServerArgs" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="fromDefaultDatadirWithServerArgs(serverArgParser:org.bitcoins.commons.util.ServerArgParser)(implicitsystem:akka.actor.ActorSystem):org.bitcoins.server.BitcoinSAppConfig" class="anchorToMember"></a><a id="fromDefaultDatadirWithServerArgs(ServerArgParser)(ActorSystem):BitcoinSAppConfig" class="anchorToMember"></a> <span class="permalink"><a href="../../../org/bitcoins/server/BitcoinSAppConfig$.html#fromDefaultDatadirWithServerArgs(serverArgParser:org.bitcoins.commons.util.ServerArgParser)(implicitsystem:akka.actor.ActorSystem):org.bitcoins.server.BitcoinSAppConfig" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">fromDefaultDatadirWithServerArgs</span><span class="params">(<span name="serverArgParser">serverArgParser: <a href="../commons/util/ServerArgParser.html" name="org.bitcoins.commons.util.ServerArgParser" id="org.bitcoins.commons.util.ServerArgParser" class="extype">ServerArgParser</a></span>)</span><span class="params">(<span class="implicit">implicit </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><span class="result">: <a href="BitcoinSAppConfig.html" name="org.bitcoins.server.BitcoinSAppConfig" id="org.bitcoins.server.BitcoinSAppConfig" class="extype">BitcoinSAppConfig</a></span></span><p class="shortcomment cmt">Creates a BitcoinSAppConfig the the given daemon args to a server</p></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]" class="anchorToMember"></a><a id="getClass():Class[_&lt;:AnyRef]" class="anchorToMember">