Packages

c

glngn.server.host

FixedDomainHost

abstract class FixedDomainHost[AppParams] extends ServerHost[AppParams]

A glngn server application with a fixed deployment name and top level domain. Simplifies building a server application that includes only a specific set of services bundled with the server jar. Also enables adding domain specific parameters to the application.

Linear Supertypes
ServerHost[AppParams], prelude.IOLogging, PreludeBuilders, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. FixedDomainHost
  2. ServerHost
  3. IOLogging
  4. PreludeBuilders
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

Type Members

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

    Definition Classes
    ServerHost

Abstract Value Members

  1. abstract val deploymentName: String

    Name of this application.

  2. abstract def deploymentPrelude: prelude.Prelude

    The prelude (List of PreludeEntry) included in this deployment.

    The prelude (List of PreludeEntry) included in this deployment. The structure declared here takes precedence.

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]

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

    Definition Classes
    ServerHost
  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.

    Definition Classes
    ServerHost
  10. val deploymentEffectBindings: List[EffectBinding]

    Injectible values for this deployment.

  11. 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.
    Definition Classes
    ServerHost
  12. def dispatchOnCommandParse(appParams: AppParams, commandName: String, isCommandUsage: Boolean, isCommandHelp: Boolean, maybeHostCommand: Either[caseapp.core.Error, HostCommand]): prelude.ZIO[BaseEnvironment, Nothing, Int]

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

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

    Definition Classes
    ServerHost
  35. def printCommandUsage(commandName: String): prelude.ZIO[BaseEnvironment, Nothing, Int]

    Definition Classes
    ServerHost
  36. def printConfigThenExit: ServerTask[Int]

    Definition Classes
    ServerHost
  37. def printConfigThenExit(config: Config): prelude.Task[Int]

    Definition Classes
    ServerHost
  38. def printFullConfigThenExit: ServerTask[Int]

    Definition Classes
    ServerHost
  39. def printFullConfigThenExit(config: Config): prelude.Task[Int]

    Definition Classes
    ServerHost
  40. def printHelpThenExit: prelude.ZIO[BaseEnvironment, Nothing, Int]

    Definition Classes
    ServerHost
  41. def printUsageThenExit: prelude.ZIO[BaseEnvironment, Nothing, Int]

    Definition Classes
    ServerHost
  42. def printVersionThenExit: prelude.Task[Int]

    Definition Classes
    ServerHost
  43. def resolveConfig(deploymentConfig: DeploymentConfig, appParams: AppParams): HostTask[Config]

    Definition Classes
    ServerHost
  44. def resolveDeploymentConfig(appParams: AppParams): HostTask[DeploymentConfig]

    Definition Classes
    FixedDomainHost → ServerHost
  45. def resolveDeploymentConfig(deploymentName: DeploymentName, appParams: AppParams): HostTask[DeploymentConfig]

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

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

    Definition Classes
    ServerHost
  46. def resolveEffectBindings(deploymentConfig: DeploymentConfig, appParams: AppParams): HostTask[List[EffectBinding]]

    Definition Classes
    FixedDomainHost → ServerHost
  47. def resolvePrelude(deploymentConfig: DeploymentConfig, appParams: AppParams): HostTask[prelude.Prelude]

    Derive the deployment prelude dynamically.

    Derive the deployment prelude dynamically.

    By default, this is exactly: Task(deploymentPrelude)

    Definition Classes
    FixedDomainHost → ServerHost
  48. 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)
    Definition Classes
    ServerHost
  49. 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.

    Definition Classes
    ServerHost
  50. def serverParamsForHost(deploymentConfig: DeploymentConfig, appParams: AppParams): HostTask[ServerParams[AppParams]]

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

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

    Definition Classes
    ServerHost
  54. 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
    Definition Classes
    ServerHost
  55. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  56. def toString(): String
    Definition Classes
    AnyRef → Any
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  60. object logger

    Definition Classes
    IOLogging

Inherited from ServerHost[AppParams]

Inherited from prelude.IOLogging

Inherited from PreludeBuilders

Inherited from AnyRef

Inherited from Any

Domain

Service Logic

Implementation Detail

Ungrouped