Reference
This is the reference documentation for an Alpakka connector. This section should contain a general overview of the connector and mention the libraries and APIs that the connector is using. Also it should link to external resources that might help to learn about the technology the connector is using.
Reported issues
Artifacts
- sbt
libraryDependencies += "com.lightbend.akka" %% "akka-stream-alpakka-reference" % "1.1.2"
- Maven
<dependency> <groupId>com.lightbend.akka</groupId> <artifactId>akka-stream-alpakka-reference_2.12</artifactId> <version>1.1.2</version> </dependency>
- Gradle
dependencies { compile group: 'com.lightbend.akka', name: 'akka-stream-alpakka-reference_2.12', version: '1.1.2' }
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 License com.typesafe.akka akka-stream_2.12 2.5.23 Apache License, Version 2.0 org.scala-lang scala-library 2.12.7 BSD 3-Clause - Dependency tree
com.typesafe.akka akka-stream_2.12 2.5.23 Apache License, Version 2.0 com.typesafe.akka akka-actor_2.12 2.5.23 Apache License, Version 2.0 com.typesafe config 1.3.3 Apache License, Version 2.0 org.scala-lang.modules scala-java8-compat_2.12 0.8.0 BSD 3-clause org.scala-lang scala-library 2.12.7 BSD 3-Clause org.scala-lang scala-library 2.12.7 BSD 3-Clause com.typesafe.akka akka-protobuf_2.12 2.5.23 Apache License, Version 2.0 org.scala-lang scala-library 2.12.7 BSD 3-Clause com.typesafe ssl-config-core_2.12 0.3.7 Apache-2.0 com.typesafe config 1.3.3 Apache License, Version 2.0 org.scala-lang.modules scala-parser-combinators_2.12 1.1.1 BSD 3-clause org.scala-lang scala-library 2.12.7 BSD 3-Clause org.scala-lang scala-library 2.12.7 BSD 3-Clause org.reactivestreams reactive-streams 1.0.2 CC0 org.scala-lang scala-library 2.12.7 BSD 3-Clause org.scala-lang scala-library 2.12.7 BSD 3-Clause
Reading messages
Give a brief description of the usage of this connector. If you want to mention a class name, make sure to link to the API docs: ReferenceReadResult
.
If any of the API classes are different between Scala and Java, link to both API docs: Reference
Reference
.
Show an example code snippet of how a source of this connector can be created.
- Scala
-
val settings: SourceSettings = SourceSettings(ClientId) val source: Source[ReferenceReadResult, Future[Done]] = Reference.source(settings)
- Java
-
final SourceSettings settings = SourceSettings.create(clientId); final Source<ReferenceReadResult, CompletionStage<Done>> source = Reference.source(settings);
Wrap language specific text with language specific directives, like @scala
for Scala specific text@java
for Java specific text.
Writing messages
Show an example code snippet of how a flow of this connector can be created.