akka.actor

IOManager

final class IOManager extends Extension

IOManager contains a reference to the akka.actor.IOManagerActor for an akka.actor.ActorSystem.

This is the recommended entry point to creating sockets for performing IO.

Use the companion object to retrieve the instance of this class for an ActorSystem.

val ioManager = IOManager(context.system)
val socket = ioManager.connect("127.0.0.1")

An IOManager does not need to be manually stopped when not in use as it will automatically enter an idle state when it has no channels to manage.

Linear Supertypes
Extension, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. IOManager
  2. Extension
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. val actor: ActorRef

    A reference to the akka.actor.IOManagerActor that performs the actual IO.

    A reference to the akka.actor.IOManagerActor that performs the actual IO. It communicates with other actors using subclasses of akka.actor.IO.IOMessage.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  9. def connect(host: String, port: Int)(implicit owner: ActorRef): SocketHandle

    Create a SocketChannel connecting to a host and port.

    Create a SocketChannel connecting to a host and port. Messages will be sent from the akka.actor.IOManagerActor to the owner akka.actor.ActorRef.

    host

    the hostname or IP to connect to

    port

    the port to connect to

    owner

    the ActorRef that will receive messages from the IOManagerActor

    returns

    a akka.actor.IO.SocketHandle to uniquely identify the created socket

  10. def connect(address: SocketAddress, options: Seq[SocketOption] = Seq.empty)(implicit owner: ActorRef): SocketHandle

    Create a SocketChannel connecting to an address.

    Create a SocketChannel connecting to an address. Messages will be sent from the akka.actor.IOManagerActor to the owner akka.actor.ActorRef.

    address

    the address to connect to

    options

    Seq of akka.actor.IO.SocketOption to setup on established socket

    owner

    the ActorRef that will receive messages from the IOManagerActor

    returns

    a akka.actor.IO.SocketHandle to uniquely identify the created socket

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  12. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  13. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  15. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. def listen(host: String, port: Int, options: Seq[ServerSocketOption] = Seq.empty)(implicit owner: ActorRef): ServerHandle

    Create a ServerSocketChannel listening on a host and port.

    Create a ServerSocketChannel listening on a host and port. Messages will be sent from the akka.actor.IOManagerActor to the owner akka.actor.ActorRef.

    host

    the hostname or IP to listen on

    port

    the port to listen on

    options

    Seq of akka.actor.IO.ServerSocketOption to setup on socket

    owner

    the ActorRef that will receive messages from the IOManagerActor

    returns

    a akka.actor.IO.ServerHandle to uniquely identify the created socket

  18. def listen(address: SocketAddress)(implicit owner: ActorRef): ServerHandle

    Create a ServerSocketChannel listening on an address.

    Create a ServerSocketChannel listening on an address. Messages will be sent from the akka.actor.IOManagerActor to the owner akka.actor.ActorRef.

    address

    the address to listen on

    owner

    the ActorRef that will receive messages from the IOManagerActor

    returns

    a akka.actor.IO.ServerHandle to uniquely identify the created socket

  19. def listen(address: SocketAddress, options: Seq[ServerSocketOption])(implicit owner: ActorRef): ServerHandle

    Create a ServerSocketChannel listening on an address.

    Create a ServerSocketChannel listening on an address. Messages will be sent from the akka.actor.IOManagerActor to the owner akka.actor.ActorRef.

    address

    the address to listen on

    owner

    the ActorRef that will receive messages from the IOManagerActor

    returns

    a akka.actor.IO.ServerHandle to uniquely identify the created socket

  20. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  23. val settings: Settings

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

    Definition Classes
    AnyRef

  25. def toString(): String

    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Ungrouped