Skip to content

Commit

Permalink
Doc and version updates for M3
Browse files Browse the repository at this point in the history
  • Loading branch information
rajinisivaram committed Jul 18, 2017
1 parent 85a4aa8 commit 15cf4b4
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ With Gradle from repo.spring.io:
dependencies {
//compile "io.projectreactor.kafka:reactor-kafka:1.0.0.BUILD-SNAPSHOT"
compile "io.projectreactor.kafka:reactor-kafka:1.0.0.M2"
compile "io.projectreactor.kafka:reactor-kafka:1.0.0.M3"
}
```

Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ ext {

kafkaVersion = '0.11.0.0'
scalaVersion = '2.11'
reactorVersion = '3.1.0.BUILD-SNAPSHOT'
reactorVersion = '3.1.0.M3'
metricsVersion = '2.2.0'

argparseVersion = '0.5.0'
Expand Down
18 changes: 9 additions & 9 deletions src/docs/asciidoc/api-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@
This section describes the reactive API for producing and consuming messages using Apache Kafka.
There are two main interfaces in Reactor Kafka:

. `reactor.kafka.KafkaSender` for publishing messages to Kafka
. `reactor.kafka.KafkaReceiver` for consuming messages from Kafka
. `reactor.kafka.sender.KafkaSender` for publishing messages to Kafka
. `reactor.kafka.receiver.KafkaReceiver` for consuming messages from Kafka

Full API for Reactor Kafka is available in the link:../../api/index.html[javadocs].
Full API for Reactor Kafka is available in the link:../api/index.html[javadocs].

The project uses https://github.com/reactor/reactor-core[Reactor Core] to expose a https://github.com/reactive-streams/reactive-streams-jvm["Reactive Streams"] API.


[[api-guide-sender]]
=== Reactive Kafka Sender

Outbound messages are sent to Kafka using `reactor.kafka.KafkaSender`. Senders are thread-safe and can be shared
Outbound messages are sent to Kafka using `reactor.kafka.sender.KafkaSender`. Senders are thread-safe and can be shared
across multiple threads to improve throughput. A `KafkaSender` is associated with one `KafkaProducer` that is used
to transport messages to Kafka.

Expand Down Expand Up @@ -77,9 +77,9 @@ provides a hands-on tutorial on using the Reactor classes `Flux` and `Mono`.

[source,java]
--------
Flux<SenderRecord<Integer. String> outboundFlux =
Flux<SenderRecord<Integer, String, Integer>> outboundFlux =
Flux.range(1, 10)
.map(i -> SenderRecord.create(topic, partition, timestamp, i, "Message_" + i, i);
.map(i -> SenderRecord.create(topic, partition, timestamp, i, "Message_" + i, i));
--------

The code segment above creates a sequence of messages to send to Kafka, using the message index as
Expand Down Expand Up @@ -178,7 +178,7 @@ after the configured number of retries.
--------
sender.sendOutbound(flux1) // <1>
.send(flux2)
.send(flux3))
.send(flux3)
.then() // <2>
.doOnError(e -> e.printStackTrace()) // <3>
.doOnSuccess(s -> System.out.println("Sends succeeded")) // <4>
Expand Down Expand Up @@ -344,7 +344,7 @@ Partitions may be manually assigned to the receiver without using Kafka consumer

[source,java]
--------
receiverOptions = receiverOptions.assignment(Collections.singleton(new TopicPartition(topic, 0)); // <1>
receiverOptions = receiverOptions.assignment(Collections.singleton(new TopicPartition(topic, 0))); // <1>
--------
<1> Consume from partition 0 of specified topic

Expand Down Expand Up @@ -418,7 +418,7 @@ any records consumed using `KafkaReceiver#receive()`.

[source,java]
--------
receiverOptions = ReceiverOptions.create()
receiverOptions = ReceiverOptions.<Integer, String>create()
.commitInterval(Duration.ZERO) // <1>
.commitBatchSize(0); // <2>
KafkaReceiver.create(receiverOptions)
Expand Down
4 changes: 2 additions & 2 deletions src/docs/asciidoc/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ For gradle:
[source]
--------
dependencies {
compile "io.projectreactor.kafka:reactor-kafka:1.0.0.BUILD-SNAPSHOT"
compile "io.projectreactor.kafka:reactor-kafka:1.0.0.M3"
}
--------

Expand All @@ -172,7 +172,7 @@ For maven:
<dependency>
<groupId>io.projectreactor.kafka</groupId>
<artifactId>reactor-kafka</artifactId>
<version>1.0.0.BUILD-SNAPSHOT</version>
<version>1.0.0.M3</version>
</dependency>
--------

2 changes: 1 addition & 1 deletion src/docs/asciidoc/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Reactor Kafka Reference Guide
Rajini Sivaram, Mark Pollack
:appversion: 1.0.0.BUILD-SNAPSHOT
:appversion: 1.0.0.M3
ifndef::host-github[:ext-relative: {outfilesuffix}]
{appversion}
:doctype: book
Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This enables exchange of data between threads with well-defined memory usage, av

=== Reactive API for Kafka

link:index.html[Reactor Kafka] is a reactive API for Kafka based on Reactor and the Kafka Producer/Consumer API.
link:../api/index.html[Reactor Kafka] is a reactive API for Kafka based on Reactor and the Kafka Producer/Consumer API.
Reactor Kafka API enables messages to be published to Kafka and consumed from Kafka using functional APIs
with non-blocking back-pressure and very low overheads. This enables applications using Reactor to use
Kafka as a message bus or streaming platform and integrate with other systems to provide an end-to-end reactive pipeline.
Expand Down

0 comments on commit 15cf4b4

Please sign in to comment.