akka.io

UdpConnected

object UdpConnected extends ExtensionKey[UdpConnectedExt]

UDP Extension for Akka’s IO layer.

All contents of the `akka.io` package is marked “experimental”.

This marker signifies that APIs may still change in response to user feedback through-out the 2.2 release cycle. The implementation itself is considered stable and ready for production use.

This extension implements the connectionless UDP protocol with calling connect on the underlying sockets, i.e. with restricting from whom data can be received. For “unconnected” UDP mode see akka.io.Udp.

For a full description of the design and philosophy behind this IO implementation please refer to the Akka online documentation.

Linear Supertypes
ExtensionKey[UdpConnectedExt], ExtensionIdProvider, ExtensionId[UdpConnectedExt], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UdpConnected
  2. ExtensionKey
  3. ExtensionIdProvider
  4. ExtensionId
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. trait Command extends HasFailureMessage with Message

    The common type of all commands supported by the UDP implementation.

  2. case class CommandFailed(cmd: Command) extends Event with Product with Serializable

    When a command fails it will be replied to with this message type, wrapping the failing command object.

  3. case class Connect(handler: ActorRef, remoteAddress: InetSocketAddress, localAddress: Option[InetSocketAddress] = scala.None, options: Traversable[SocketOption] = immutable.this.Nil) extends Command with Product with Serializable

    Send this message to the akka.io.UdpExt#manager in order to bind to a local port (optionally with the chosen localAddress) and create a UDP socket which is restricted to sending to and receiving from the given remoteAddress.

  4. sealed trait Connected extends Event

    This message is sent by the connection actor to the actor which sent the akka.io.Udp.Connect message when the UDP socket has been bound to the local and remote addresses given.

  5. sealed trait Disconnected extends Event

    This message is sent by the connection actor to the actor which sent the akka.io.Udp.Disconnect message when the UDP socket has been closed.

  6. trait Event extends Message

    The common type of all events emitted by the UDP implementation.

  7. sealed trait Message extends AnyRef

    The common interface for akka.io.Udp.Command and akka.io.Udp.Event.

  8. case class NoAck(token: Any) extends Event with Product with Serializable

    Each akka.io.Udp.Send can optionally request a positive acknowledgment to be sent to the commanding actor.

  9. case class Received(data: ByteString) extends Event with Product with Serializable

    When a connection actor receives a datagram from its socket it will send it to the handler designated in the akka.io.Udp.Bind message using this message type.

  10. case class Send(payload: ByteString, ack: Any) extends Command with Product with Serializable

    This message is understood by the connection actors to send data to their designated destination.

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. object Connected extends Connected with Product with Serializable

  7. object Disconnect extends Command with Product with Serializable

    Send this message to a connection actor (which had previously sent the akka.io.Udp.Connected message) in order to close the socket.

  8. object Disconnected extends Disconnected with Product with Serializable

  9. object NoAck extends NoAck

    Default akka.io.Udp.NoAck instance which is used when no acknowledgment information is explicitly provided.

  10. object ResumeReading extends Command with Product with Serializable

    This message must be sent to the listener actor to re-enable reading from the socket after a akka.io.Udp.SuspendReading command.

  11. object Send extends Serializable

  12. object SuspendReading extends Command with Product with Serializable

    Send this message to a listener actor (which sent a akka.io.Udp.Bound message) to have it stop reading datagrams from the network.

  13. def apply(system: ActorSystem): UdpConnectedExt

    Definition Classes
    ExtensionId

  14. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  15. def clone(): AnyRef

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

  16. def createExtension(system: ExtendedActorSystem): UdpConnectedExt

    Definition Classes
    ExtensionKey → ExtensionId

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

    Definition Classes
    AnyRef

  18. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  19. def finalize(): Unit

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

  20. def get(system: ActorSystem): UdpConnectedExt

    Java API: retrieve the UdpConnected extension for the given system.

    Java API: retrieve the UdpConnected extension for the given system.

    Definition Classes
    UdpConnected → ExtensionId

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

    Definition Classes
    AnyRef → Any

  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  24. def lookup(): ExtensionId[UdpConnectedExt]

    Definition Classes
    ExtensionKey → ExtensionIdProvider

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

    Definition Classes
    AnyRef

  26. final def notify(): Unit

    Definition Classes
    AnyRef

  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  29. def toString(): String

    Definition Classes
    AnyRef → Any

  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExtensionKey[UdpConnectedExt]

Inherited from ExtensionIdProvider

Inherited from ExtensionId[UdpConnectedExt]

Inherited from AnyRef

Inherited from Any

Ungrouped