akka.io

Udp

object Udp extends ExtensionId[UdpExt] with ExtensionIdProvider

UDP Extension for Akka’s IO layer.

This extension implements the connectionless UDP protocol without calling connect on the underlying sockets, i.e. without restricting from whom data can be received. For “connected” UDP mode see UdpConnected.

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

The Java API for generating UDP commands is available at UdpMessage.

Source
Udp.scala
Linear Supertypes
Content Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Udp
  2. ExtensionIdProvider
  3. ExtensionId
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class Bind(handler: ActorRef, localAddress: InetSocketAddress, options: Traversable[SocketOption] = immutable.this.Nil) extends Command with Product with Serializable

    Send this message to the UdpExt#manager in order to bind to the given local port (or an automatically assigned one if the port number is zero).

  2. case class Bound(localAddress: InetSocketAddress) extends Event with Product with Serializable

    This message is sent by the listener actor in response to a Bind command.

  3. trait Command extends HasFailureMessage with Message

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

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

  5. trait Event extends Message

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

  6. sealed trait Message extends AnyRef

    The common interface for Command and Event.

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

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

  8. case class Received(data: ByteString, sender: InetSocketAddress) extends Event with Product with Serializable

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

  9. case class Send(payload: ByteString, target: InetSocketAddress, ack: Event) extends Command with Product with Serializable

    This message is understood by the “simple sender” which can be obtained by sending the SimpleSender query to the UdpExt#manager as well as by the listener actors which are created in response to Bind.

  10. case class SimpleSender(options: Traversable[SocketOption] = immutable.this.Nil) extends Command with Product with Serializable

    Retrieve a reference to a “simple sender” actor of the UDP extension.

  11. sealed trait SimpleSenderReady extends Event

    The “simple sender” sends this message type in response to a SimpleSender query.

  12. sealed trait Unbound extends AnyRef

    This message is sent by the listener actor in response to an Unbind command after the socket has been closed.

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 NoAck extends NoAck

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

  7. 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 SuspendReading command.

  8. object SO extends SoForwarders

    Scala API: This object provides access to all socket options applicable to UDP sockets.

  9. object Send extends Serializable

  10. object SimpleSender extends SimpleSender

  11. object SimpleSenderReady extends SimpleSenderReady with Product with Serializable

  12. object SuspendReading extends Command with Product with Serializable

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

  13. object Unbind extends Command with Product with Serializable

    Send this message to the listener actor that previously sent a Bound message in order to close the listening socket.

  14. object Unbound extends Unbound with Product with Serializable

  15. def apply(system: ActorSystem): UdpExt

    Returns an instance of the extension identified by this ExtensionId instance.

    Returns an instance of the extension identified by this ExtensionId instance.

    Definition Classes
    ExtensionId
  16. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. def createExtension(system: ExtendedActorSystem): UdpExt

    Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.

    Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.

    Definition Classes
    UdpExtensionId
  19. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  22. def get(system: ActorSystem): UdpExt

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

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

    Definition Classes
    UdpExtensionId
  23. final def getClass(): Class[_]

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

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

    Definition Classes
    Any
  26. def lookup(): Udp.type

    Returns the canonical ExtensionId for this Extension

    Returns the canonical ExtensionId for this Extension

    Definition Classes
    UdpExtensionIdProvider
  27. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  30. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  31. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ExtensionIdProvider

Inherited from ExtensionId[UdpExt]

Inherited from AnyRef

Inherited from Any

Ungrouped