WorkerConfig

Instance Constructors

new WorkerConfig(c: Config)

Type Members

implicit class RichArgs extends AnyRef

Definition Classes
LowPriorityImplicits
implicit class RichMap extends AnyRef

Definition Classes
LowPriorityImplicits
implicit class RichString extends AnyRef

Definition Classes
LowPriorityImplicits

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def actorSystemName: String

Definition Classes
ServerConfig
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asList(path: String, separator: Option[String] = Option(",")): List[String]

produces a scala list, either from a StringList or a comma-separated string value
produces a scala list, either from a StringList or a comma-separated string value
path
the config path
separator
if specified, the value at the given path will be parsed if it is a string and not a stringlist

Definition Classes
RichConfigOps
implicit def asRichConfig(c: Config): RichConfig

Definition Classes
LowPriorityImplicits
def chunkSize: Int

Definition Classes
ServerConfig
lazy val clientConfig: ClientConfig

We have server settings like this:
We have server settings like this:
```
host : abc
port : 123

client : {
  host : abc
  port : 123
}
```
To allow the user to override run-time client and server settings in light of the two-step typesafe config resolution, we allow the client to take on 'default' host and port values (empty string and 0, respectively) so that we can fall-back to (resolved) server host/port values.
Definition Classes
ServerConfig
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def collectAsMap: Map[String, String]

Definition Classes
RichConfigOps
def collectAsStrings: List[(String, String)]

Definition Classes
RichConfigOps
val config: Config

Definition Classes
ServerConfig → RichConfigOps
lazy val defaultExchangeClient: ExchangeClient

Attributes
protected
def describe(implicit opts: ConfigRenderOptions = concise().setFormatted(true)): String

Definition Classes
RichConfigOps
def enableSupportRoutes: Boolean

Definition Classes
ServerConfig
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def exchangeClient: ExchangeClient
lazy val exchangeConfig: ExchangeConfig

returns
exchange pointed at by this worker
def filterNot(path: (String) ⇒ Boolean): Config

Definition Classes
RichConfigOps
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def host: String

Definition Classes
ServerConfig
def hostLocationForConfig(c: Config): HostLocation

Definition Classes
ServerConfig
def includeExchangeRoutes: Boolean
def includeSwaggerRoutes: Boolean

Definition Classes
ServerConfig
def includeUIRoutes: Boolean

Definition Classes
ServerConfig
def initialRequest: Int

returns
the initial amount of work to request from the exchange
def intersect(other: Config): Config

Definition Classes
RichConfigOps
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def json: String

Definition Classes
RichConfigOps
def landingPage: String
def launchBrowser: Boolean

Definition Classes
ServerConfig
def location: HostLocation

Definition Classes
ServerConfig
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newConfig(overrides: Map[String, String]): Config

Attributes
protected
Definition Classes
ServerConfig
def newSystem(name: String = nextActorSystemName): AkkaImplicits

Definition Classes
ServerConfig
def newWorkerRoutes(exchange: Exchange): DynamicWorkerRoutes
def nextActorSystemName(): String

Definition Classes
ServerConfig
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def or(other: Config): Config

Definition Classes
RichConfigOps
def pathRoots: List[String]

Definition Classes
RichConfigOps
def paths: List[String]

Definition Classes
RichConfigOps
def port: Int

Definition Classes
ServerConfig
def routes(exchangeRoutes: Option[Route]): Route
def runWithRoutes[T](routes: Route, svc: T): Future[RunningService[ServerConfig, T]]

Definition Classes
ServerConfig
lazy val serverImplicits: AkkaImplicits

Definition Classes
ServerConfig
def show(options: ConfigRenderOptions = ...): Option[String]

If 'show' specified, either by just 'show' on its own or 'show=path.to.config.or.value', then this will return the configuration at that path
If 'show' specified, either by just 'show' on its own or 'show=path.to.config.or.value', then this will return the configuration at that path
returns
the optional value of what's pointed to if 'show=<path>' is specified

Definition Classes
RichConfigOps
def startWorker(): Future[RunningWorker]
def subscription: WorkSubscription
lazy val subscriptionConfig: SubscriptionConfig
def swaggerApiClasses: Set[Class[_]]

Attributes
protected
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
ServerConfig → AnyRef → Any
def unique: Config

Definition Classes
RichConfigOps
def uniquePaths: List[String]

And example which uses most of the below stuff to showcase what this is for Note : writing a 'diff' using this would be pretty straight forward
And example which uses most of the below stuff to showcase what this is for Note : writing a 'diff' using this would be pretty straight forward

Definition Classes
RichConfigOps
def unmarshalTimeout: FiniteDuration
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def waitOnUserInput: Boolean

Definition Classes
ServerConfig
def withFallback(fallback: Config): WorkerConfig

Definition Classes
WorkerConfig → ServerConfig
def withOverrides(overrides: Config): WorkerConfig

Definition Classes
WorkerConfig → ServerConfig
def withPaths(paths: List[String]): Config

Definition Classes
RichConfigOps
def withPaths(first: String, theRest: String*): Config

Definition Classes
RichConfigOps
def withUserArgs(args: Array[String], unrecognizedArg: (String) ⇒ Config = ParseArg.Throw): Config

args
the user arguments in the form <key>=<value>, <filePath> or <fileOnTheClasspath>
unrecognizedArg
what to do with malformed user input
returns
a configuration with the given user-argument overrides applied over top

Definition Classes
RichConfigOps
def without(paths: TraversableOnce[String]): Config

Definition Classes
RichConfigOps
def without(firstPath: String, theRest: String*): Config

Definition Classes
RichConfigOps
def without(other: Config): Config

Definition Classes
RichConfigOps
def withoutSystem: Config

this config w/o the system props and stuff
this config w/o the system props and stuff

Definition Classes
RichConfigOps

Related Docs: object WorkerConfig | package worker

class WorkerConfig extends ServerConfig

Instance Constructors

new WorkerConfig(c: Config)

Type Members

implicit class RichArgs extends AnyRef

implicit class RichMap extends AnyRef

implicit class RichString extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def actorSystemName: String

final def asInstanceOf[T0]: T0

def asList(path: String, separator: Option[String] = Option(",")): List[String]

implicit def asRichConfig(c: Config): RichConfig

def chunkSize: Int

lazy val clientConfig: ClientConfig

def clone(): AnyRef

def collectAsMap: Map[String, String]

def collectAsStrings: List[(String, String)]

val config: Config

lazy val defaultExchangeClient: ExchangeClient

def describe(implicit opts: ConfigRenderOptions = concise().setFormatted(true)): String

def enableSupportRoutes: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exchangeClient: ExchangeClient

lazy val exchangeConfig: ExchangeConfig

def filterNot(path: (String) ⇒ Boolean): Config

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def host: String

def hostLocationForConfig(c: Config): HostLocation

def includeExchangeRoutes: Boolean

def includeSwaggerRoutes: Boolean

def includeUIRoutes: Boolean

def initialRequest: Int

def intersect(other: Config): Config

final def isInstanceOf[T0]: Boolean

def json: String

def landingPage: String

def launchBrowser: Boolean

def location: HostLocation

final def ne(arg0: AnyRef): Boolean

def newConfig(overrides: Map[String, String]): Config

def newSystem(name: String = nextActorSystemName): AkkaImplicits

def newWorkerRoutes(exchange: Exchange): DynamicWorkerRoutes

def nextActorSystemName(): String

final def notify(): Unit

final def notifyAll(): Unit

def or(other: Config): Config

def pathRoots: List[String]

def paths: List[String]

def port: Int

def routes(exchangeRoutes: Option[Route]): Route

def runWithRoutes[T](routes: Route, svc: T): Future[RunningService[ServerConfig, T]]

lazy val serverImplicits: AkkaImplicits

def show(options: ConfigRenderOptions = ...): Option[String]

def startWorker(): Future[RunningWorker]

def subscription: WorkSubscription

lazy val subscriptionConfig: SubscriptionConfig

def swaggerApiClasses: Set[Class[_]]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def unique: Config

def uniquePaths: List[String]

def unmarshalTimeout: FiniteDuration

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def waitOnUserInput: Boolean

def withFallback(fallback: Config): WorkerConfig

def withOverrides(overrides: Config): WorkerConfig

def withPaths(paths: List[String]): Config

def withPaths(first: String, theRest: String*): Config

def withUserArgs(args: Array[String], unrecognizedArg: (String) ⇒ Config = ParseArg.Throw): Config

def without(paths: TraversableOnce[String]): Config