code.grnet.gr Git - aquarium/blob - logic/src/main/scala/gr/grnet/aquarium/user/actor/UserActorsLRU.scala

   1 /*
   2  * Copyright 2011 GRNET S.A. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or
   5  * without modification, are permitted provided that the following
   6  * conditions are met:
   7  *
   8  *   1. Redistributions of source code must retain the above
   9  *      copyright notice, this list of conditions and the following
  10  *      disclaimer.
  11  *
  12  *   2. Redistributions in binary form must reproduce the above
  13  *      copyright notice, this list of conditions and the following
  14  *      disclaimer in the documentation and/or other materials
  15  *      provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
  18  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
  21  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  24  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  27  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * The views and conclusions contained in the software and
  31  * documentation are those of the authors and should not be
  32  * interpreted as representing official policies, either expressed
  33  * or implied, of GRNET S.A.
  34  */
  35
  36 package gr.grnet.aquarium.user.actor
  37
  38 import org.apache.solr.util.ConcurrentLRUCache
  39 import akka.actor.ActorRef
  40 import gr.grnet.aquarium.util.{Loggable, Lifecycle}
  41
  42 /**
  43  * This class holds an LRU cache for the user actors.
  44  *
  45  * The underlying implementation is borrowed from the Apache lucene+solr project(s).
  46  *
  47  * The provided collections-like API is neither Java- nor Scala-oriented.
  48  *
  49  * @author Christos KK Loverdos <loverdos@gmail.com>
  50  */
  51
  52 class UserActorsLRU(val upperWaterMark: Int, val lowerWatermark: Int) extends Lifecycle {
  53   private[this] val _cache = new ConcurrentLRUCache[String, ActorRef](
  54     upperWaterMark,
  55     lowerWatermark,
  56     ((upperWaterMark + lowerWatermark).toLong / 2).toInt,
  57     (3L * upperWaterMark / 4).toInt,
  58     true,
  59     false,
  60     EvictionListener)
  61
  62   def put(userId: String, userActor: ActorRef): Unit = {
  63     _cache.put(userId, userActor)
  64   }
  65
  66   def get(userId: String): Option[ActorRef] = {
  67     _cache.get(userId) match {
  68       case null     ⇒ None
  69       case actorRef ⇒ Some(actorRef)
  70     }
  71   }
  72
  73   def size: Int   = _cache.size()
  74   def clear: Unit = _cache.clear()
  75
  76   def start() = {}
  77
  78   def stop() = {
  79     _cache.destroy()
  80   }
  81
  82   private[this] object EvictionListener extends ConcurrentLRUCache.EvictionListener[String, ActorRef] with Loggable {
  83     def evictedEntry(userId: String, userActor: ActorRef): Unit = {
  84       logger.debug("Parking UserActor for userId = %s".format(userId))
  85       // Check this is received after any currently servicing business logic message.
  86       userActor ! UserActorStop
  87       // Hopefully no need to further track these actors as they will now cause their own death.
  88     }
  89   }
  90 }
  91