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
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  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. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from IOManager to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (IOManager, B)

    Implicit information
    This member is added by an implicit conversion from IOManager to ArrowAssoc[IOManager] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  8. 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.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def ensuring(cond: (IOManager) ⇒ Boolean, msg: ⇒ Any): IOManager

    Implicit information
    This member is added by an implicit conversion from IOManager to Ensuring[IOManager] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (IOManager) ⇒ Boolean): IOManager

    Implicit information
    This member is added by an implicit conversion from IOManager to Ensuring[IOManager] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): IOManager

    Implicit information
    This member is added by an implicit conversion from IOManager to Ensuring[IOManager] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): IOManager

    Implicit information
    This member is added by an implicit conversion from IOManager to Ensuring[IOManager] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from IOManager to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

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

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

    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  25. val settings: Settings

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

    Definition Classes
    AnyRef
  27. def toString(): String

    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def [B](y: B): (IOManager, B)

    Implicit information
    This member is added by an implicit conversion from IOManager to ArrowAssoc[IOManager] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from IOManager to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (iOManager: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from IOManager to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (iOManager: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. 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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use the new implementation in package akka.io instead

  2. def connect(address: SocketAddress, options: Seq[SocketOption] = Nil)(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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use the new implementation in package akka.io instead

  3. def listen(host: String, port: Int, options: Seq[ServerSocketOption] = Nil)(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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use the new implementation in package akka.io instead

  4. 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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use the new implementation in package akka.io instead

  5. 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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use the new implementation in package akka.io instead

  6. def x: IOManager

    Implicit information
    This member is added by an implicit conversion from IOManager to ArrowAssoc[IOManager] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (iOManager: ArrowAssoc[IOManager]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  7. def x: IOManager

    Implicit information
    This member is added by an implicit conversion from IOManager to Ensuring[IOManager] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (iOManager: Ensuring[IOManager]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from IOManager to StringAdd

Inherited by implicit conversion any2stringfmt from IOManager to StringFormat

Inherited by implicit conversion any2ArrowAssoc from IOManager to ArrowAssoc[IOManager]

Inherited by implicit conversion any2Ensuring from IOManager to Ensuring[IOManager]

Ungrouped