Packages

abstract class ServerHost[AppParams] extends PreludeBuilders with prelude.IOLogging

An application hosting at least one server node.

Start with DynamicConfigHost then FixedDomainHost.

Linear Supertypes
prelude.IOLogging, PreludeBuilders, AnyRef, Any
Known Subclasses
DynamicConfigHost, FixedDomainHost
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. ServerHost
  2. IOLogging
  3. PreludeBuilders
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ServerHost()(implicit appParamsParser: Parser[AppParams], appParamsHelp: Help[AppParams])

Type Members

  1. type BaseEnvironment = Blocking with Clock with Console with System

Abstract Value Members

  1. abstract def resolveDeploymentConfig(appParams: AppParams): HostTask[DeploymentConfig]

    Given the application parameters resolve the deployment configuration.

  2. abstract def resolveEffectBindings(deploymentConfig: DeploymentConfig, appParams: AppParams): HostTask[List[EffectBinding]]

    Given the application parameters resolve the effect bindings for this deployment.

  3. abstract def resolvePrelude(deploymentConfig: DeploymentConfig, appParams: AppParams): HostTask[Prelude]

    Given the server parameters, resolve the prelude for this server deployment.

    Given the server parameters, resolve the prelude for this server deployment.

    The standardPrelude is prefixed to this glngn.server.model.Prelude.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val _unsafeLogger: prelude.Logger
    Attributes
    protected
    Definition Classes
    IOLogging
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. def clusteredHostCommand(deploymentConfig: DeploymentConfig, appParams: AppParams, hostCommand: HostCommand): HostUIO[Int]

  8. def clusteredNodeCommandHandler(params: ServerParams[AppParams], hostCommand: HostCommand): HostTask[Int]

  9. def clusteredRunUntilTerm(params: ServerParams[AppParams]): ServerIO[node.Error, node.TermReason]

    Does not complete until this cluster node completes.

    Does not complete until this cluster node completes. Returns cause of termination. Error occurs if the server is unable to start.

  10. def dispatchOnArgs(args: List[String]): prelude.ZIO[BaseEnvironment, Nothing, Int]

    Given a list of arguments and a HostCommandHandler either return a program for assisting with usage that exits immediately or dispatches to onHostCommand.

    Given a list of arguments and a HostCommandHandler either return a program for assisting with usage that exits immediately or dispatches to onHostCommand.

    Specifically, this is one of:

    0. on no args provided: a program that reports the error and exits with status code 1.

    1. on failure to parse param args a program that reports the error and exits with status code 1.
    2. on failure to parse a command a program that reports the error and exits with status code 1. 2. on usage or help request a program that provides the requested output and exits with status code 0. 3. on command the parsed command and params are provided to onHostCommand.
  11. def dispatchOnCommandParse(appParams: AppParams, commandName: String, isCommandUsage: Boolean, isCommandHelp: Boolean, maybeHostCommand: Either[caseapp.core.Error, HostCommand]): prelude.ZIO[BaseEnvironment, Nothing, Int]

  12. val empty: Prelude
    Definition Classes
    PreludeBuilders
  13. def enableGroup(groupId: GroupId, entry: Enable): Prelude
    Definition Classes
    PreludeBuilders
  14. def enableGroup(groupId: GroupId, groupName: Option[GroupName], operators: Option[Set[Identity]]): Prelude
    Definition Classes
    PreludeBuilders
  15. def enableGroup(groupId: GroupId, groupName: GroupName, operators: Set[Identity]): Prelude
    Definition Classes
    PreludeBuilders
  16. def enableGroup(groupId: GroupId, operators: Set[Identity]): Prelude
    Definition Classes
    PreludeBuilders
  17. def enableGroup(groupId: GroupId, groupName: GroupName): Prelude
    Definition Classes
    PreludeBuilders
  18. def enableGroup(groupId: GroupId): Prelude
    Definition Classes
    PreludeBuilders
  19. def enableService(groupId: GroupId, serviceId: ServiceId, logicalServiceId: LogicalServiceId): Prelude
    Definition Classes
    PreludeBuilders
  20. def enableService(groupId: GroupId, serviceId: ServiceId, serviceFragment: ServiceFragment): Prelude
    Definition Classes
    PreludeBuilders
  21. def enableService(logicalServiceId: LogicalServiceId, serviceFragment: ServiceFragment): Prelude
    Definition Classes
    PreludeBuilders
  22. def enableService(serviceFragment: ServiceFragment): Prelude
    Definition Classes
    PreludeBuilders
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. final def main(args: Array[String]): Unit

  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. def printCommandHelp(commandName: String): prelude.ZIO[BaseEnvironment, Nothing, Int]

  34. def printCommandUsage(commandName: String): prelude.ZIO[BaseEnvironment, Nothing, Int]

  35. def printConfigThenExit: ServerTask[Int]

  36. def printConfigThenExit(config: Config): prelude.Task[Int]

  37. def printFullConfigThenExit: ServerTask[Int]

  38. def printFullConfigThenExit(config: Config): prelude.Task[Int]

  39. def printHelpThenExit: prelude.ZIO[BaseEnvironment, Nothing, Int]

  40. def printUsageThenExit: prelude.ZIO[BaseEnvironment, Nothing, Int]

  41. def printVersionThenExit: prelude.Task[Int]

  42. def resolveConfig(deploymentConfig: DeploymentConfig, appParams: AppParams): HostTask[Config]

  43. def resolveDeploymentConfig(deploymentName: DeploymentName, appParams: AppParams): HostTask[DeploymentConfig]

    Given a name of the deployment and application parameters, resolve the configuration of this deployment.

  44. def run(args: List[String]): prelude.ZIO[BaseEnvironment, Nothing, Int]

    Given application arguments as a list of strings (EG: executable args provided to main).

    Given application arguments as a list of strings (EG: executable args provided to main). Provide a server application that, when run, will complete once the server completes. Returning the numeric exit code of the server application.

    Default implementation:

    dispatchOnArgs(args)
  45. def runUntilExit[R <: Logging](app: prelude.ZIO[R, Error, TermReason]): prelude.ZIO[R, Nothing, Int]

    Does not complete until the server completes.

    Does not complete until the server completes. Returns process exit code. An exit code of 0 indicates the server completed due to a normal event. An exit code of non-0 indicates an unrecoverable error occurred.

  46. def serverParamsForHost(deploymentConfig: DeploymentConfig, appParams: AppParams): HostTask[ServerParams[AppParams]]

  47. def setGroupName(groupId: GroupId, groupName: GroupName): Prelude
    Definition Classes
    PreludeBuilders
  48. def standaloneHostCommand(deploymentConfig: DeploymentConfig, appParams: AppParams, hostCommand: HostCommand): HostUIO[Int]

  49. def standaloneRunUntilTerm(deploymentConfig: DeploymentConfig, appParams: AppParams, stateDir: prelude.Path, options: Run): Host[TermReason]

  50. def standardPrelude: Prelude

    The standardPrelude is prefixed to resolvePrelude.

    The standardPrelude is prefixed to resolvePrelude. This adds the services under glngn.server.services to the set of available services but does not instantiate any of these services.

    To remove all standard services:

    override def standardPrelude: Prelude = Prelude.empty
  51. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  52. def toString(): String
    Definition Classes
    AnyRef → Any
  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  56. object logger

    Definition Classes
    IOLogging

Inherited from prelude.IOLogging

Inherited from PreludeBuilders

Inherited from AnyRef

Inherited from Any

Domain

Service Logic

Implementation Detail

Ungrouped