Class

eu.akkamo

AkkaModule

Related Doc: package akkamo

Permalink

class AkkaModule extends Module with Initializable with Disposable

Register one or more Actor System

configuration example:
akkamo.akka = {
  // one block with akka configuration contains several aliases with the name name
  name1 = {
    aliases = ["alias1, "alias2"]
    // standard akka attributes for example:
   	akka{
   	  loglevel = "DEBUG"
     	debug {
     	  lifecycle = on
    	}
    }
   	// ....
  },
  name2 = { // not aliases - only one block allowed
    default = true
    ....
  }
}

In a case when more than one akka configuration exists, one must be denoted as default
In case when missing configuration one default Akka system is created with name default.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AkkaModule
  2. Disposable
  3. Initializable
  4. Module
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new AkkaModule()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. val AkkaSystemsKey: String

    Permalink

    pointer to array containing set of akka Actor System names in configuration

  5. val Aliases: String

    Permalink

    in concrete akka config points to array of aliases

  6. val Name: String

    Permalink

    the name of actor system

  7. val actorSystems: Set[ActorSystem]

    Permalink
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def dependencies(dependencies: Dependency): Dependency

    Permalink

    Each Akkamo module must override this method in order to exactly define its module dependencies, otherwise there will be risk that it will not be initialized and run in proper order.

    Each Akkamo module must override this method in order to exactly define its module dependencies, otherwise there will be risk that it will not be initialized and run in proper order. Fox example if this module depends on modules ModuleA and ModuleB, then the overridden method should look like:

    override def dependencies(dependencies: Dependency): Dependency =
      dependencies.&&[ModuleA].&&[ModuleB]ś
    dependencies

    instance of eu.akkamo.Dependency

    returns

    chained module dependencies

    Definition Classes
    AkkaModuleModule
  11. def dispose(ctx: Context): Res[Unit]

    Permalink

    Method the module extending this trait must implement, all logic performed by the module before Akkamo system shutdown should be here.

    Method the module extending this trait must implement, all logic performed by the module before Akkamo system shutdown should be here. As an input parameter, Akkamo context is provided.

    ctx

    Akkamo context

    returns

    instance of Res

    Definition Classes
    AkkaModuleDisposable
    Annotations
    @throws( "If dispose execution fails" )
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. def iKey(): Class[_ <: Initializable]

    Permalink

    Instance of eu.akkamo.Initializable is registered into the Akkamo context by default under this module class.

    Instance of eu.akkamo.Initializable is registered into the Akkamo context by default under this module class. Override this method in order to achieve different registration key class, for example an interface instead of concrete implementation.

    returns

    registration key class

    Definition Classes
    Initializable
  18. def initialize(ctx: Context): Res[Context]

    Permalink

    Initializes the module into provided mutable context, blocking

    Initializes the module into provided mutable context, blocking

    ctx

    Akkamo context

    returns

    instance of Res that contains (new if modified) instance of eu.akkamo.Context or exception packed in Try

    Definition Classes
    AkkaModuleInitializable
  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink

    Default implementation of toString of Akkamo module returns the module name itself (simple class name).

    Default implementation of toString of Akkamo module returns the module name itself (simple class name).

    returns

    simple class name of the Akkamo module

    Definition Classes
    Module → AnyRef → Any
  25. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Disposable

Inherited from Initializable

Inherited from Module

Inherited from AnyRef

Inherited from Any

Ungrouped