Apache Pekko
2.0.0-M3
API
Generated with
Apache Pekko/org.apache.pekko/org.apache.pekko.io/Udp

Udp

org.apache.pekko.io.Udp
object Udp extends ExtensionId[UdpExt], 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 Pekko online documentation.

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

Attributes

Source
Udp.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Udp.type

Members list

Type members

Classlikes

final case class Bind(handler: ActorRef, localAddress: InetSocketAddress, options: Iterable[SocketOption] = ...) extends Command

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). The listener actor for the newly bound port will reply with a Bound message, or the manager will reply with a CommandFailed message.

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). The listener actor for the newly bound port will reply with a Bound message, or the manager will reply with a CommandFailed message.

Attributes

Source
Udp.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Command
trait Message
trait HasFailureMessage
class Object
trait Matchable
class Any
Show all
final case class Bound(localAddress: InetSocketAddress) extends Event

This message is sent by the listener actor in response to a Bind command. If the address to bind to specified a port number of zero, then this message can be inspected to find out which port was automatically assigned.

This message is sent by the listener actor in response to a Bind command. If the address to bind to specified a port number of zero, then this message can be inspected to find out which port was automatically assigned.

Attributes

Source
Udp.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Event
trait Message
class Object
trait Matchable
class Any
Show all
trait Command extends HasFailureMessage, Message

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

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

Attributes

Source
Udp.scala
Supertypes
trait Message
trait HasFailureMessage
class Object
trait Matchable
class Any
Known subtypes
class Bind
object ResumeReading
class Send
class SimpleSender
object SimpleSender
object Unbind
Show all
final case class CommandFailed(cmd: Command) extends Event

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

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

Attributes

Source
Udp.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Event
trait Message
class Object
trait Matchable
class Any
Show all
trait Event extends Message

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

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

Attributes

Source
Udp.scala
Supertypes
trait Message
class Object
trait Matchable
class Any
Known subtypes
class Bound
class NoAck
object NoAck
class Received
Show all
sealed trait Message

The common interface for Command and Event.

The common interface for Command and Event.

Attributes

Source
Udp.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Command
class Bind
object ResumeReading
class Send
class SimpleSender
object SimpleSender
object Unbind
trait Event
class Bound
class NoAck
object NoAck
class Received
Show all
case class NoAck(token: Any) extends Event

Each Send can optionally request a positive acknowledgment to be sent to the commanding actor. If such notification is not desired the Send#ack must be set to an instance of this class. The token contained within can be used to recognize which write failed when receiving a CommandFailed message.

Each Send can optionally request a positive acknowledgment to be sent to the commanding actor. If such notification is not desired the Send#ack must be set to an instance of this class. The token contained within can be used to recognize which write failed when receiving a CommandFailed message.

Attributes

Companion
object
Source
Udp.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Event
trait Message
class Object
trait Matchable
class Any
Show all
Known subtypes
object NoAck
object NoAck extends NoAck

Default NoAck instance which is used when no acknowledgment information is explicitly provided. Its “token” is null.

Default NoAck instance which is used when no acknowledgment information is explicitly provided. Its “token” is null.

Attributes

Companion
class
Source
Udp.scala
Supertypes
trait Product
trait Mirror
class NoAck
trait Serializable
trait Product
trait Equals
trait Event
trait Message
class Object
trait Matchable
class Any
Show all
Self type
NoAck.type
final case class Received(data: ByteString, sender: InetSocketAddress) extends Event

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.

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.

Attributes

Source
Udp.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Event
trait Message
class Object
trait Matchable
class Any
Show all
case object ResumeReading extends Command

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

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

Attributes

Source
Udp.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Command
trait Message
trait HasFailureMessage
class Object
trait Matchable
class Any
Show all
Self type
object SO extends SoForwarders

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

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

For the Java API see UdpSO.

Attributes

Source
Udp.scala
Supertypes
trait SoForwarders
class Object
trait Matchable
class Any
Self type
SO.type
final case class Send(payload: ByteString, target: InetSocketAddress, ack: Event) extends Command

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. It will send the given payload data as one UDP datagram to the given target address. The UDP actor will respond with CommandFailed if the send could not be enqueued to the O/S kernel because the send buffer was full. If the given ack is not of type NoAck the UDP actor will reply with the given object as soon as the datagram has been successfully enqueued to the O/S kernel.

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. It will send the given payload data as one UDP datagram to the given target address. The UDP actor will respond with CommandFailed if the send could not be enqueued to the O/S kernel because the send buffer was full. If the given ack is not of type NoAck the UDP actor will reply with the given object as soon as the datagram has been successfully enqueued to the O/S kernel.

The sending UDP socket’s address belongs to the “simple sender” which does not handle inbound datagrams and sends from an ephemeral port; therefore sending using this mechanism is not suitable if replies are expected, use Bind in that case.

Attributes

Companion
object
Source
Udp.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Command
trait Message
trait HasFailureMessage
class Object
trait Matchable
class Any
Show all
object Send

Attributes

Companion
class
Source
Udp.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Send.type
case class SimpleSender(options: Iterable[SocketOption] = ...) extends Command

Retrieve a reference to a “simple sender” actor of the UDP extension. The newly created “simple sender” will reply with the SimpleSenderReady notification.

Retrieve a reference to a “simple sender” actor of the UDP extension. The newly created “simple sender” will reply with the SimpleSenderReady notification.

The “simple sender” is a convenient service for being able to send datagrams when the originating address is meaningless, i.e. when no reply is expected.

The “simple sender” will not stop itself, you will have to send it a pekko.actor.PoisonPill when you want to close the socket.

Attributes

Companion
object
Source
Udp.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait Command
trait Message
trait HasFailureMessage
class Object
trait Matchable
class Any
Show all
Known subtypes
object SimpleSender
object SimpleSender extends SimpleSender

Attributes

Companion
class
Source
Udp.scala
Supertypes
trait Product
trait Mirror
class SimpleSender
trait Serializable
trait Product
trait Equals
trait Command
trait Message
trait HasFailureMessage
class Object
trait Matchable
class Any
Show all
Self type
case object SimpleSenderReady extends SimpleSenderReady

Attributes

Companion
trait
Source
Udp.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Event
trait Message
class Object
trait Matchable
class Any
Show all
Self type
sealed trait SimpleSenderReady extends Event

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

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

Attributes

Companion
object
Source
Udp.scala
Supertypes
trait Event
trait Message
class Object
trait Matchable
class Any
Known subtypes
case object SuspendReading extends Command

Send this message to a listener actor (which sent a Bound message) to have it stop reading datagrams from the network. If the O/S kernel’s receive buffer runs full then subsequent datagrams will be silently discarded. Re-enable reading from the socket using the ResumeReading command.

Send this message to a listener actor (which sent a Bound message) to have it stop reading datagrams from the network. If the O/S kernel’s receive buffer runs full then subsequent datagrams will be silently discarded. Re-enable reading from the socket using the ResumeReading command.

Attributes

Source
Udp.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Command
trait Message
trait HasFailureMessage
class Object
trait Matchable
class Any
Show all
Self type
case object Unbind extends Command

Send this message to the listener actor that previously sent a Bound message in order to close the listening socket. The recipient will reply with an Unbound message.

Send this message to the listener actor that previously sent a Bound message in order to close the listening socket. The recipient will reply with an Unbound message.

Attributes

Source
Udp.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Command
trait Message
trait HasFailureMessage
class Object
trait Matchable
class Any
Show all
Self type
Unbind.type
case object Unbound extends Unbound

Attributes

Companion
trait
Source
Udp.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Unbound
class Object
trait Matchable
class Any
Show all
Self type
Unbound.type
sealed trait Unbound

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

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

Attributes

Companion
object
Source
Udp.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Unbound

Value members

Concrete methods

override def createExtension(system: ExtendedActorSystem): UdpExt

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

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

Attributes

Definition Classes
Source
Udp.scala
override 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.

Attributes

Definition Classes
Source
Udp.scala
override def get(system: ClassicActorSystemProvider): UdpExt

Returns an instance of the extension identified by this ExtensionId instance. Java API For extensions written in Scala that are to be used from Java also, this method should be overridden to get correct return type.

Returns an instance of the extension identified by this ExtensionId instance. Java API For extensions written in Scala that are to be used from Java also, this method should be overridden to get correct return type.

override def get(system: ClassicActorSystemProvider): TheExtension = super.get(system)

Attributes

Definition Classes
Source
Udp.scala
override def lookup: ExtensionId[_ <: Extension]

Returns the canonical ExtensionId for this Extension

Returns the canonical ExtensionId for this Extension

Attributes

Definition Classes
Source
Udp.scala

Inherited methods

def apply(system: ClassicActorSystemProvider): UdpExt

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

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

Attributes

Inherited from:
ExtensionId
Source
Extension.scala
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.

Attributes

Inherited from:
ExtensionId
Source
Extension.scala
final override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
ExtensionId -> Any
Inherited from:
ExtensionId
Source
Extension.scala
final override def hashCode: Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
ExtensionId -> Any
Inherited from:
ExtensionId
Source
Extension.scala
Generated with