Packages

trait RoleService[+F[_]] extends AbstractRole[F]

A type of role representing a persistent service.

Will be kept running forever up until the application is interrupted.

Linear Supertypes
AbstractRole[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RoleService
  2. AbstractRole
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def start(roleParameters: RawEntrypointParams, freeArgs: Vector[String]): Lifecycle[F, Unit]

    Returns a izumi.distage.model.definition.Lifecycle with the start/shutdown of a service described by its acquire/release actions.

    Returns a izumi.distage.model.definition.Lifecycle with the start/shutdown of a service described by its acquire/release actions. The acquired service will be kept alive until the application is interrupted or is otherwise finished, then the specified release action of the Lifecycle will run for cleanup.

    Example:
    1. Often start is implemented using the izumi.distage.model.definition.Lifecycle.fork_ method to spawn a daemon fiber running the service in background.

      import izumi.distage.roles.model.RoleService
      import izumi.functional.bio.{F, IO2}
      import logstage.LogIO2
      import logstage.LogIO2.log
      
      final class HelloService[F[+_, +_]: IO2: LogIO2] extends RoleService[F] {
        def start(roleParameters: RawEntrypointParams, freeArgs: Vector[String]): Lifecycle[F[Nothing, _], Unit] = {
          Lifecycle.fork_(helloServer).void
        }
      
        val helloServer: F[Throwable, Unit] = {
          (for {
            name <- F.syncThrowable { Console.in.readLine() }
            _    <- log.info(s"Hello $name!")
          } yield ()).forever
        }
      }
    Note

    Resource initialization must be finite. Application startup won't progress until the acquire phase of the returned Lifecycle is finished. You may start a separate thread / fiber, etc during resource initialization. All the shutdown logic has to be implemented in the resource finalizer.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AbstractRole[F]

Inherited from AnyRef

Inherited from Any

Ungrouped