UDP
The UDP connector provides Akka Stream flows that allow to send and receive UDP datagrams.
Project Info: Alpakka UDP | |
---|---|
Artifact | com.lightbend.akka
akka-stream-alpakka-udp
2.0.2
|
JDK versions | Adopt OpenJDK 8 Adopt OpenJDK 11 |
Scala versions | 2.12.11, 2.11.12, 2.13.3 |
JPMS module name | akka.stream.alpakka.udp |
License | |
Readiness level |
Since 0.20, 2018-07-04
|
Home page | https://doc.akka.io/docs/alpakka/current |
API documentation | |
Forums | |
Release notes | In the documentation |
Issues | Github issues |
Sources | https://github.com/akka/alpakka |
Artifacts
- sbt
val AkkaVersion = "2.5.31" libraryDependencies ++= Seq( "com.lightbend.akka" %% "akka-stream-alpakka-udp" % "2.0.2", "com.typesafe.akka" %% "akka-stream" % AkkaVersion )
- Maven
<properties> <akka.version>2.5.31</akka.version> <scala.binary.version>2.12</scala.binary.version> </properties> <dependency> <groupId>com.lightbend.akka</groupId> <artifactId>akka-stream-alpakka-udp_${scala.binary.version}</artifactId> <version>2.0.2</version> </dependency> <dependency> <groupId>com.typesafe.akka</groupId> <artifactId>akka-stream_${scala.binary.version}</artifactId> <version>${akka.version}</version> </dependency>
- Gradle
versions += [ AkkaVersion: "2.5.31", ScalaBinary: "2.12" ] dependencies { compile group: 'com.lightbend.akka', name: "akka-stream-alpakka-udp_${versions.ScalaBinary}", version: '2.0.2', compile group: 'com.typesafe.akka', name: "akka-stream_${versions.ScalaBinary}", version: versions.AkkaVersion }
The table below shows direct dependencies of this module and the second tab shows all libraries it depends on transitively.
- Direct dependencies
Organization Artifact Version com.typesafe.akka akka-stream_2.12 2.5.31 org.scala-lang scala-library 2.12.11 - Dependency tree
com.typesafe.akka akka-stream_2.12 2.5.31 com.typesafe.akka akka-actor_2.12 2.5.31 com.typesafe config 1.3.3 org.scala-lang.modules scala-java8-compat_2.12 0.8.0 org.scala-lang scala-library 2.12.11 org.scala-lang scala-library 2.12.11 com.typesafe.akka akka-protobuf_2.12 2.5.31 org.scala-lang scala-library 2.12.11 com.typesafe ssl-config-core_2.12 0.3.8 com.typesafe config 1.3.3 org.scala-lang.modules scala-parser-combinators_2.12 1.1.2 org.scala-lang scala-library 2.12.11 org.scala-lang scala-library 2.12.11 org.reactivestreams reactive-streams 1.0.2 org.scala-lang scala-library 2.12.11 org.scala-lang scala-library 2.12.11
Sending
Datagrams can be sent to remote destinations by using a Udp.sendFlow
or Udp.sendSink
which can be found in the Udp
Udp
factory object.
- Scala
-
val destination = new InetSocketAddress("my.server", 27015) val messagesToSend = 100 Source(1 to messagesToSend) .map(i => ByteString(s"Message $i")) .map(Datagram(_, destination)) .runWith(Udp.sendSink())
- Java
-
final InetSocketAddress destination = new InetSocketAddress("my.server", 27015); final Integer messagesToSend = 100; Source.range(1, messagesToSend) .map(i -> ByteString.fromString("Message " + i)) .map(bs -> Datagram.create(bs, destination)) .runWith(Udp.sendSink(system), materializer);
Receiving
First create an address which will be used to bind and listen for incoming datagrams.
- Scala
-
val bindToLocal = new InetSocketAddress("localhost", 0)
- Java
-
final InetSocketAddress bindToLocal = new InetSocketAddress("localhost", 0);
A Flow created from Udp.bindFlow
will bind to the given address. All datagrams coming from the network to the bound address will be sent downstream. Datagrams received from the upstream will be sent to their corresponding destination addresses.
The flow materializes to the Future[InetSocketAddress]
CompletionStage<InetSocketAddress>
which will eventually hold the address the flow was finally bound to.
- Scala
-
val bindFlow: Flow[Datagram, Datagram, Future[InetSocketAddress]] = Udp.bindFlow(bindToLocal)
- Java
-
final Flow<Datagram, Datagram, CompletionStage<InetSocketAddress>> bindFlow = Udp.bindFlow(bindToLocal, system);
Running the example code
The code in this guide is part of runnable tests of this project. You are welcome to browse the code, edit and run it in sbt.
- Scala
-
sbt > udp/testOnly *.UdpSpec
- Java
-
sbt > udp/testOnly *.UdpTest