# Reference

This is the reference documentation for an Apache Pekko Connectors 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

[Tagged issues at Github](https://github.com/apache/pekko-connectors/labels/p%3Areference)

## Artifacts

@@dependency [sbt,Maven,Gradle] {
  group=org.apache.pekko
  artifact=pekko-connectors-reference_$scala.binary.version$
  version=$project.version$
  symbol2=PekkoVersion
  value2=$pekko.version$
  group2=org.apache.pekko
  artifact2=pekko-stream_$scala.binary.version$
  version2=PekkoVersion
}

The table below shows direct dependencies of this module and the second tab shows all libraries it depends on transitively.

@@dependencies { projectId="reference" }


## 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:
@scaladoc[ReferenceReadResult](org.apache.pekko.stream.connectors.reference.ReferenceReadResult).

If any of the API classes are different between Scala and Java, link to both API docs:
@scala[@scaladoc[Reference](org.apache.pekko.stream.connectors.reference.scaladsl.Reference$)]
@java[@scaladoc[Reference](org.apache.pekko.stream.connectors.reference.javadsl.Reference$)].

Show an example code snippet of how a source of this connector can be created.

Scala
: @@snip [snip](/reference/src/test/scala/docs/scaladsl/ReferenceSpec.scala) { #source }

Java
: @@snip [snip](/reference/src/test/java/docs/javadsl/ReferenceTest.java) { #source }

Wrap language specific text with language specific directives,
like @scala[`@scala` for Scala specific text]@java[`@java` for Java specific text].

## Writing messages

Show an example code snippet of how a flow of this connector can be created.

Scala
: @@snip [snip](/reference/src/test/scala/docs/scaladsl/ReferenceSpec.scala) { #flow }

Java
: @@snip [snip](/reference/src/test/java/docs/javadsl/ReferenceTest.java) { #flow }
