akka.remoteinterface

RemoteSupport

class RemoteSupport extends ListenerManagement with RemoteServerModule with RemoteClientModule

Attributes
abstract
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. RemoteSupport
  2. RemoteClientModule
  3. RemoteServerModule
  4. RemoteModule
  5. ListenerManagement
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RemoteSupport ()

Abstract Value Members

  1. def actorFor (serviceId: String, className: String, timeout: Long, hostname: String, port: Int, loader: Option[ClassLoader]): ActorRef

    Attributes
    protected[akka] abstract
    Definition Classes
    RemoteClientModule
  2. def address : InetSocketAddress

    Gets the address of the server instance

    Gets the address of the server instance

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  3. def isRunning : Boolean

    Signals whether the server is up and running or not

    Signals whether the server is up and running or not

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  4. def name : String

    Gets the name of the server instance

    Gets the name of the server instance

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  5. def optimizeLocalScoped_? (): Boolean

    Attributes
    abstract
    Definition Classes
    RemoteModule
  6. def register (id: String, actorRef: ActorRef): Unit

    Register Remote Actor by a specific 'id' passed as argument.

    Register Remote Actor by a specific 'id' passed as argument. The actor is registered by UUID rather than ID when prefixing the handle with the “uuid:” protocol.

    NOTE: If you use this method to register your remote actor then you must unregister the actor by this ID yourself.

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  7. def registerByUuid (actorRef: ActorRef): Unit

    Register Remote Actor by the Actor's uuid field.

    Register Remote Actor by the Actor's uuid field. It starts the Actor if it is not started already.

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  8. def registerPerSession (id: String, factory: ⇒ ActorRef): Unit

    Register Remote Session Actor by a specific 'id' passed as argument.

    Register Remote Session Actor by a specific 'id' passed as argument.

    NOTE: If you use this method to register your remote actor then you must unregister the actor by this ID yourself.

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  9. def registerTypedActor (id: String, typedActor: AnyRef): Unit

    Register remote typed actor by a specific id.

    Register remote typed actor by a specific id.

    id

    custom actor id

    typedActor

    typed actor to register

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  10. def registerTypedPerSessionActor (id: String, factory: ⇒ AnyRef): Unit

    Register remote typed actor by a specific id.

    Register remote typed actor by a specific id.

    id

    custom actor id

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  11. def restartClientConnection (address: InetSocketAddress): Boolean

    Restarts a specific client connected to the supplied remote address, but only if the client is not shut down

    Restarts a specific client connected to the supplied remote address, but only if the client is not shut down

    Attributes
    abstract
    Definition Classes
    RemoteClientModule
  12. def send [T] (message: Any, senderOption: Option[ActorRef], senderFuture: Option[CompletableFuture[T]], remoteAddress: InetSocketAddress, timeout: Long, isOneWay: Boolean, actorRef: ActorRef, typedActorInfo: Option[(String, String)], actorType: ActorType, loader: Option[ClassLoader]): Option[CompletableFuture[T]]

    Attributes
    protected[akka] abstract
    Definition Classes
    RemoteClientModule
  13. def shutdownClientConnection (address: InetSocketAddress): Boolean

    Shuts down a specific client connected to the supplied remote address returns true if successful

    Shuts down a specific client connected to the supplied remote address returns true if successful

    Attributes
    abstract
    Definition Classes
    RemoteClientModule
  14. def shutdownClientModule (): Unit

    Clean-up all open connections.

    Clean-up all open connections.

    Attributes
    abstract
    Definition Classes
    RemoteClientModule
  15. def shutdownServerModule (): Unit

    Shuts the server down

    Shuts the server down

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  16. def start (host: String, port: Int, loader: Option[ClassLoader]): RemoteServerModule

    Starts the server up

    Starts the server up

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  17. def typedActorFor [T] (intfClass: Class[T], serviceId: String, implClassName: String, timeout: Long, host: String, port: Int, loader: Option[ClassLoader]): T

    Methods that needs to be implemented by a transport *

    Methods that needs to be implemented by a transport *

    Attributes
    protected[akka] abstract
    Definition Classes
    RemoteClientModule
  18. def unregister (id: String): Unit

    Unregister Remote Actor by specific 'id'.

    Unregister Remote Actor by specific 'id'.

    NOTE: You need to call this method if you have registered an actor by a custom ID.

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  19. def unregister (actorRef: ActorRef): Unit

    Unregister Remote Actor that is registered using its 'id' field (not custom ID).

    Unregister Remote Actor that is registered using its 'id' field (not custom ID).

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  20. def unregisterPerSession (id: String): Unit

    Unregister Remote Actor by specific 'id'.

    Unregister Remote Actor by specific 'id'.

    NOTE: You need to call this method if you have registered an actor by a custom ID.

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  21. def unregisterTypedActor (id: String): Unit

    Unregister Remote Typed Actor by specific 'id'.

    Unregister Remote Typed Actor by specific 'id'.

    NOTE: You need to call this method if you have registered an actor by a custom ID.

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  22. def unregisterTypedPerSessionActor (id: String): Unit

    Unregister Remote Typed Actor by specific 'id'.

    Unregister Remote Typed Actor by specific 'id'.

    NOTE: You need to call this method if you have registered an actor by a custom ID.

    Attributes
    abstract
    Definition Classes
    RemoteServerModule
  23. def clientManagedActorOf (factory: () ⇒ Actor, host: String, port: Int): ActorRef

    Attributes
    abstract
    Definition Classes
    RemoteClientModule
    Annotations
    @deprecated
    Deprecated

    Will be removed after 1.1

Concrete Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. val UUID_PREFIX : String

    Definition Classes
    RemoteModule
  7. def actorFor (serviceId: String, className: String, timeout: Long, hostname: String, port: Int): ActorRef

    Definition Classes
    RemoteClientModule
  8. def actorFor (classNameOrServiceId: String, timeout: Long, hostname: String, port: Int, loader: ClassLoader): ActorRef

    Definition Classes
    RemoteClientModule
  9. def actorFor (classNameOrServiceId: String, timeout: Long, hostname: String, port: Int): ActorRef

    Definition Classes
    RemoteClientModule
  10. def actorFor (serviceId: String, className: String, hostname: String, port: Int, loader: ClassLoader): ActorRef

    Definition Classes
    RemoteClientModule
  11. def actorFor (serviceId: String, className: String, hostname: String, port: Int): ActorRef

    Definition Classes
    RemoteClientModule
  12. def actorFor (classNameOrServiceId: String, hostname: String, port: Int, loader: ClassLoader): ActorRef

    Definition Classes
    RemoteClientModule
  13. def actorFor (classNameOrServiceId: String, hostname: String, port: Int): ActorRef

    Definition Classes
    RemoteClientModule
  14. def addListener (listener: ActorRef): Unit

    Adds the listener this this registry's listener list.

    Adds the listener this this registry's listener list. The listener is started by this method if manageLifeCycleOfListeners yields true.

    Definition Classes
    ListenerManagement
  15. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  16. def clear : Unit

  17. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  18. def createActorFromClass (clazz: Class[_]): Actor

    Attributes
    protected
  19. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  20. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  21. lazy val eventHandler : ActorRef

  22. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  23. def foreachListener (f: (ActorRef) ⇒ Unit): Unit

    Execute f with each listener as argument.

    Execute f with each listener as argument. ActorInitializationException is not handled.

    Attributes
    protected[akka]
    Definition Classes
    ListenerManagement
  24. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef
  25. val guard : ReentrantGuard

    Attributes
    protected
    Definition Classes
    RemoteServerModule
  26. def hasListener (listener: ActorRef): Boolean

    Checks if a specific listener is registered.

    Checks if a specific listener is registered. ActorInitializationException leads to removal of listener if that one isShutdown.

    Definition Classes
    ListenerManagement
  27. def hasListeners : Boolean

    Definition Classes
    ListenerManagement
  28. def hashCode (): Int

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

    Attributes
    final
    Definition Classes
    Any
  30. def manageLifeCycleOfListeners : Boolean

    Specifies whether listeners should be started when added and stopped when removed or not

    Specifies whether listeners should be started when added and stopped when removed or not

    Attributes
    protected
    Definition Classes
    RemoteSupportListenerManagement
  31. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  32. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  33. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  34. def notifyListeners (message: ⇒ Any): Unit

    Attributes
    protected[akka]
    Definition Classes
    RemoteSupportRemoteModuleListenerManagement
  35. def register (actorRef: ActorRef): Unit

    Register Remote Actor by the Actor's 'id' field.

    Register Remote Actor by the Actor's 'id' field. It starts the Actor if it is not started already.

    Definition Classes
    RemoteServerModule
  36. def registerPerSession (id: String, factory: Creator[ActorRef]): Unit

    Register Remote Session Actor by a specific 'id' passed as argument.

    Register Remote Session Actor by a specific 'id' passed as argument.

    NOTE: If you use this method to register your remote actor then you must unregister the actor by this ID yourself. Java API

    Definition Classes
    RemoteServerModule
  37. def registerTypedActor (intfClass: Class[_], typedActor: AnyRef): Unit

    Register typed actor by interface name.

    Register typed actor by interface name.

    Definition Classes
    RemoteServerModule
  38. def registerTypedPerSessionActor (id: String, factory: Creator[AnyRef]): Unit

    Register remote typed actor by a specific id.

    Register remote typed actor by a specific id.

    id

    custom actor id

    Definition Classes
    RemoteServerModule
  39. def registerTypedPerSessionActor (intfClass: Class[_], factory: Creator[AnyRef]): Unit

    Register typed actor by interface name.

    Register typed actor by interface name. Java API

    Definition Classes
    RemoteServerModule
  40. def registerTypedPerSessionActor (intfClass: Class[_], factory: ⇒ AnyRef): Unit

    Register typed actor by interface name.

    Register typed actor by interface name.

    Definition Classes
    RemoteServerModule
  41. def removeListener (listener: ActorRef): Unit

    Removes the listener this this registry's listener list.

    Removes the listener this this registry's listener list. The listener is stopped by this method if manageLifeCycleOfListeners yields true.

    Definition Classes
    ListenerManagement
  42. def shutdown (): Unit

  43. def start (host: String, port: Int, loader: ClassLoader): RemoteServerModule

    Starts the server up

    Starts the server up

    Definition Classes
    RemoteServerModule
  44. def start (host: String, port: Int): RemoteServerModule

    Starts the server up

    Starts the server up

    Definition Classes
    RemoteServerModule
  45. def start (loader: ClassLoader): RemoteServerModule

    Starts the server up

    Starts the server up

    Definition Classes
    RemoteServerModule
  46. def start (): RemoteServerModule

    Starts the server up

    Starts the server up

    Definition Classes
    RemoteServerModule
  47. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  48. def toString (): String

    Definition Classes
    AnyRef → Any
  49. def typedActorFor [T] (intfClass: Class[T], serviceId: String, implClassName: String, timeout: Long, hostname: String, port: Int, loader: ClassLoader): T

    Definition Classes
    RemoteClientModule
  50. def typedActorFor [T] (intfClass: Class[T], serviceIdOrClassName: String, timeout: Long, hostname: String, port: Int, loader: ClassLoader): T

    Definition Classes
    RemoteClientModule
  51. def typedActorFor [T] (intfClass: Class[T], serviceIdOrClassName: String, timeout: Long, hostname: String, port: Int): T

    Definition Classes
    RemoteClientModule
  52. def typedActorFor [T] (intfClass: Class[T], serviceIdOrClassName: String, hostname: String, port: Int): T

    Definition Classes
    RemoteClientModule
  53. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  56. def actorOf [T <: Actor] (host: String, port: Int)(implicit arg0: Manifest[T]): ActorRef

    Creates a Client-managed ActorRef out of the Actor of the specified Class.

    Creates a Client-managed ActorRef out of the Actor of the specified Class. If the supplied host and port is identical of the configured local node, it will be a local actor

      import Actor._
      val actor = actorOf[MyActor]("www.akka.io",2552)
      actor.start()
      actor ! message
      actor.stop()
    
    You can create and start the actor in one statement like this:
      val actor = actorOf[MyActor]("www.akka.io",2552).start()
    

    Annotations
    @deprecated
    Deprecated

    Will be removed after 1.1

  57. def actorOf (clazz: Class[_ <: akka.actor.Actor], host: String, port: Int): ActorRef

    Creates a Client-managed ActorRef out of the Actor of the specified Class.

    Creates a Client-managed ActorRef out of the Actor of the specified Class. If the supplied host and port is identical of the configured local node, it will be a local actor

      import Actor._
      val actor = actorOf(classOf[MyActor],"www.akka.io",2552)
      actor.start()
      actor ! message
      actor.stop()
    
    You can create and start the actor in one statement like this:
      val actor = actorOf(classOf[MyActor],"www.akka.io",2552).start()
    

    Annotations
    @deprecated
    Deprecated

    Will be removed after 1.1

  58. def actorOf (factory: ⇒ Actor, host: String, port: Int): ActorRef

    Creates a Client-managed ActorRef out of the Actor of the specified Class.

    Creates a Client-managed ActorRef out of the Actor of the specified Class. If the supplied host and port is identical of the configured local node, it will be a local actor

      import Actor._
      val actor = actorOf(classOf[MyActor],"www.akka.io", 2552)
      actor.start()
      actor ! message
      actor.stop()
    
    You can create and start the actor in one statement like this:
      val actor = actorOf(classOf[MyActor],"www.akka.io", 2552).start()
    

    Annotations
    @deprecated
    Deprecated

    Will be removed after 1.1

Inherited from RemoteClientModule

Inherited from RemoteServerModule

Inherited from RemoteModule

Inherited from ListenerManagement

Inherited from AnyRef

Inherited from Any