First shot at re-doing akka-remote

akka-actor/src/main/scala/akka/remoteinterface/RemoteInterface.scala

@@ -0,0 +1,149 @@
+/**
+ * Copyright (C) 2009-2010 Scalable Solutions AB <http://scalablesolutions.se>
+ */
+
+package akka.remoteinterface
+
+import akka.japi.Creator
+import akka.actor.ActorRef
+import akka.util.{ReentrantGuard, Logging, ListenerManagement}
+
+/**
+ * This is the interface for the RemoteServer functionality, it's used in ActorRegistry.remote
+ */
+trait RemoteServerModule extends ListenerManagement with Logging {
+  protected val guard = new ReentrantGuard
+
+  /**
+   * Signals whether the server is up and running or not
+   */
+  def isRunning: Boolean
+
+  /**
+   *  Gets the name of the server instance
+   */
+  def name: String
+
+  /**
+   * Gets the current hostname of the server instance
+   */
+  def hostname: String
+
+  /**
+   *  Gets the current port of the server instance
+   */
+  def port: Int
+
+  /**
+   *  Starts the server up
+   */
+  def start(host: String, port: Int, loader: Option[ClassLoader] = None): RemoteServerModule //TODO possibly hidden
+
+  /**
+   *  Shuts the server down
+   */
+  def shutdown: Unit //TODO possibly hidden
+
+  /**
+   *  Register typed actor by interface name.
+   */
+  def registerTypedActor(intfClass: Class[_], typedActor: AnyRef) : Unit = registerTypedActor(intfClass.getName, typedActor)
+
+  /**
+   * Register remote typed actor by a specific id.
+   * @param id custom actor id
+   * @param typedActor typed actor to register
+   */
+  def registerTypedActor(id: String, typedActor: AnyRef): Unit
+
+  /**
+   * Register typed actor by interface name.
+   */
+  def registerTypedPerSessionActor(intfClass: Class[_], factory: => AnyRef) : Unit = registerTypedActor(intfClass.getName, factory)
+
+  /**
+   * Register typed actor by interface name.
+   * Java API
+   */
+  def registerTypedPerSessionActor(intfClass: Class[_], factory: Creator[AnyRef]) : Unit = registerTypedActor(intfClass.getName, factory)
+
+  /**
+   * Register remote typed actor by a specific id.
+   * @param id custom actor id
+   * @param typedActor typed actor to register
+   */
+  def registerTypedPerSessionActor(id: String, factory: => AnyRef): Unit
+
+  /**
+   * Register remote typed actor by a specific id.
+   * @param id custom actor id
+   * @param typedActor typed actor to register
+   * Java API
+   */
+  def registerTypedPerSessionActor(id: String, factory: Creator[AnyRef]): Unit = registerTypedPerSessionActor(id, factory.create)
+
+  /**
+   * Register Remote Actor by the Actor's 'id' field. It starts the Actor if it is not started already.
+   */
+  def register(actorRef: ActorRef): Unit = register(actorRef.id, actorRef)
+
+  /**
+   *  Register Remote Actor by the Actor's uuid field. It starts the Actor if it is not started already.
+   */
+  def registerByUuid(actorRef: ActorRef): Unit
+
+  /**
+   *  Register Remote Actor by a specific 'id' passed as argument.
+   * <p/>
+   * NOTE: If you use this method to register your remote actor then you must unregister the actor by this ID yourself.
+   */
+  def register(id: String, actorRef: ActorRef): Unit
+
+  /**
+   * Register Remote Session Actor by a specific 'id' passed as argument.
+   * <p/>
+   * NOTE: If you use this method to register your remote actor then you must unregister the actor by this ID yourself.
+   */
+  def registerPerSession(id: String, factory: => ActorRef): Unit
+
+  /**
+   * Register Remote Session Actor by a specific 'id' passed as argument.
+   * <p/>
+   * NOTE: If you use this method to register your remote actor then you must unregister the actor by this ID yourself.
+   * Java API
+   */
+  def registerPerSession(id: String, factory: Creator[ActorRef]): Unit = registerPerSession(id, factory.create)
+
+  /**
+   * Unregister Remote Actor that is registered using its 'id' field (not custom ID).
+   */
+  def unregister(actorRef: ActorRef): Unit
+
+  /**
+   * Unregister Remote Actor by specific 'id'.
+   * <p/>
+   * NOTE: You need to call this method if you have registered an actor by a custom ID.
+   */
+  def unregister(id: String): Unit
+
+  /**
+   * Unregister Remote Actor by specific 'id'.
+   * <p/>
+   * NOTE: You need to call this method if you have registered an actor by a custom ID.
+   */
+  def unregisterPerSession(id: String): Unit
+
+  /**
+   * Unregister Remote Typed Actor by specific 'id'.
+   * <p/>
+   * NOTE: You need to call this method if you have registered an actor by a custom ID.
+   */
+  def unregisterTypedActor(id: String): Unit
+
+  /**
+  * Unregister Remote Typed Actor by specific 'id'.
+  * <p/>
+  * NOTE: You need to call this method if you have registered an actor by a custom ID.
+  */
+ def unregisterTypedPerSessionActor(id: String): Unit
+}