DistributedCache

Instance Constructors

new DistributedCache(source: DatabaseAbstractionLayer, containerCompanions: Map[ContainerType, BasicContainerCompanion], config: Config = ...)(implicit ec: ExecutionContext, timeout: Timeout)

Creates a new instance with the supplied config or uses the default config location.
Creates a new instance with the supplied config or uses the default config location.
source
source DAL for retrieving and updating data; after the cache is created, all changes must be sent to the cache and not to the source directly
containerCompanions
map with all registered container companion objects
config
the config to use (if specified; default path is 'server.static.database.distributed-cache')
returns
the new instance
new DistributedCache(clusterHost: String, clusterPort: Int, localPort: Int, source: DatabaseAbstractionLayer, preload: Boolean, actionTimeout: Int, containerCompanions: Map[ContainerType, BasicContainerCompanion], containerTypeMaxCacheSize: Int, syncInterval: Int, maxLoadAttempts: Int, actorProvider: String)(implicit ec: ExecutionContext, timeout: Timeout)

clusterHost
cluster hostname/IP; can be set to own/local hostname/IP to initialize cluster or create single-node cluster
clusterPort
cluster port; can be set to own/local port to initialize cluster or create single-node cluster
localPort
local actor system TCP port
source
source DAL for retrieving and updating data; after the cache is created, all changes must be sent to the cache and not to the source directly
preload
if set to true, the cache will attempt to load all data during initialization (see notes)
actionTimeout
the amount of time (in seconds) before an operation is considered as timed out
containerCompanions
map with all registered container companion objects
containerTypeMaxCacheSize
maximum cache size per container type
syncInterval
message sync broadcast interval; also used for initial sync delay (see notes)
maxLoadAttempts
maximum number of times to attempt loading an object from the source
actorProvider
Akka actor provider
ec
implicit execution context

Type Members

type Receive = PartialFunction[Any, Unit]

Definition Classes
Actor

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 addReceiver(next: akka.actor.Actor.Receive): Unit

Attributes
protected
Definition Classes
Component
def aroundPostRestart(reason: Throwable): Unit

Attributes
protected[akka]
Definition Classes
Actor
def aroundPostStop(): Unit

Attributes
protected[akka]
Definition Classes
Actor
def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

Attributes
protected[akka]
Definition Classes
Actor
def aroundPreStart(): Unit

Attributes
protected[akka]
Definition Classes
Actor
def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

Attributes
protected[akka]
Definition Classes
Actor
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit val context: ActorContext

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

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

Definition Classes
AnyRef → Any
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 handle_BuildDatabaseStructure(objectsType: ContainerType): Future[Boolean]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_ClearDatabaseStructure(objectsType: ContainerType): Future[Boolean]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_CreateObject(container: Container): Future[Boolean]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_DeleteObject(objectType: ContainerType, objectID: ObjectID): Future[Boolean]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_ExecuteAction(action: String, params: Option[Map[String, Option[String]]]): Future[ActionResult]

Attributes
protected
Definition Classes
DistributedCache → Component
def handle_GetCustomQueryResult(objectsType: ContainerType, customQueryName: String, queryParams: Map[String, String]): Future[ContainerSet]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_GetDatabaseIdentifier: String

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_GetGenericQueryResult(objectsType: ContainerType): Future[ContainerSet]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_GetLayerType: LayerType

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_GetObject(objectType: ContainerType, objectID: ObjectID): Future[Container]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_GetSupportedContainers: Vector[ContainerType]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_LoadView(view: ContainerView): Future[Unit]

Attributes
protected
Definition Classes
DatabaseAbstractionLayerComponent
def handle_UpdateObject(container: MutableContainer): Future[Boolean]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def handle_VerifyDatabaseStructure(objectsType: ContainerType): Future[Boolean]

Attributes
protected
Definition Classes
DistributedCache → DatabaseAbstractionLayerComponent
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def postRestart(reason: Throwable): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def postStop(): Unit

Definition Classes
Component → Actor
def preRestart(reason: Throwable, message: Option[Any]): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def preStart(): Unit

Definition Classes
Actor
Annotations
@throws( classOf[java.lang.Exception] )
def receive: Receive

Definition Classes
Component → Actor
implicit final val self: ActorRef

Definition Classes
Actor
final def sender(): ActorRef

Definition Classes
Actor
def shutdown(): Unit

Definition Classes
DistributedCache → Component
def supervisorStrategy: SupervisorStrategy

Definition Classes
Actor
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def unhandled(message: Any): Unit

Definition Classes
Actor
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( ... )

Related Docs: object DistributedCache | package memory

class DistributedCache extends DatabaseAbstractionLayerComponent

Instance Constructors

new DistributedCache(source: DatabaseAbstractionLayer, containerCompanions: Map[ContainerType, BasicContainerCompanion], config: Config = ...)(implicit ec: ExecutionContext, timeout: Timeout)

Type Members

type Receive = PartialFunction[Any, Unit]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addReceiver(next: akka.actor.Actor.Receive): Unit

def aroundPostRestart(reason: Throwable): Unit

def aroundPostStop(): Unit

def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

def aroundPreStart(): Unit

def aroundReceive(receive: akka.actor.Actor.Receive, msg: Any): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

implicit val context: ActorContext

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def handle_BuildDatabaseStructure(objectsType: ContainerType): Future[Boolean]

def handle_ClearDatabaseStructure(objectsType: ContainerType): Future[Boolean]

def handle_CreateObject(container: Container): Future[Boolean]

def handle_DeleteObject(objectType: ContainerType, objectID: ObjectID): Future[Boolean]

def handle_ExecuteAction(action: String, params: Option[Map[String, Option[String]]]): Future[ActionResult]

def handle_GetCustomQueryResult(objectsType: ContainerType, customQueryName: String, queryParams: Map[String, String]): Future[ContainerSet]

def handle_GetDatabaseIdentifier: String

def handle_GetGenericQueryResult(objectsType: ContainerType): Future[ContainerSet]

def handle_GetLayerType: LayerType

def handle_GetObject(objectType: ContainerType, objectID: ObjectID): Future[Container]

def handle_GetSupportedContainers: Vector[ContainerType]

def handle_LoadView(view: ContainerView): Future[Unit]

def handle_UpdateObject(container: MutableContainer): Future[Boolean]

def handle_VerifyDatabaseStructure(objectsType: ContainerType): Future[Boolean]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def postRestart(reason: Throwable): Unit

def postStop(): Unit

def preRestart(reason: Throwable, message: Option[Any]): Unit

def preStart(): Unit

def receive: Receive

implicit final val self: ActorRef

final def sender(): ActorRef

def shutdown(): Unit

def supervisorStrategy: SupervisorStrategy

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

def toString(): String

def unhandled(message: Any): Unit

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from DatabaseAbstractionLayerComponent

Inherited from Component

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Ungrouped