Added documenttaion for support of RxJava 3 (#69)

Signed-off-by: Sangeeta Raghu Punnadi <[email protected]> Co-authored-by: Sangeeta Raghu Punnadi <[email protected]>
vert-x3 · Nov 6, 2023 · 8146d4f · 8146d4f
1 parent 15d0f2e
commit 8146d4f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/asciidoc/modules/con_mg_changes-in-vertx-junit5.adoc b/asciidoc/modules/con_mg_changes-in-vertx-junit5.adoc
@@ -15,6 +15,8 @@ This change resulted in following updates in JUnit5:
 * `reactiverse-junit5-extensions` module hosts extensions that contain extra parameter types, such as, `WebClient`.
 
 * RxJava 1 and 2 bindings are now available as `vertx-junit5-rx-java` and `vertx-junit5-rx-java2` modules in the `vertx-junit5-extensions` repository.
++
+From Eclipse Vert.x 4.1.0, the RxJava 3 binding `vertx-junit5-rx-java3` is available.
 
 == Deprecated succeeding and failing methods in {VertX} text context
 

diff --git a/asciidoc/modules/con_mg_changes-in-vertx-reactive-extensions.adoc b/asciidoc/modules/con_mg_changes-in-vertx-reactive-extensions.adoc
@@ -3,6 +3,22 @@
 
 This section describes the changes in Reactive Extensions (Rx) in {VertX}. {VertX} uses the RxJava library.
 
+== Support for RxJava 3
+
+From {VertX} 4.1.0, RxJava 3 is supported.
+
+* A new rxified API is available in the `io.vertx.rxjava3` package.
+
+* Integration with {VertX} JUnit5 is provided by the `vertx-junit5-rx-java3` binding.
+
+To upgrade to RxJava 3, you must make the following changes:
+
+* In the `pom.xml` file, under `<dependency>` change the RxJava 1 and 2 bindings from `vertx-rx-java` or `vertx-rx-java2` to `vertx-rx-java3`.
+
+* In your application, update the imports from `io.vertx.reactivex.\*` to `io.vertx.rxjava3.*`.
+
+* In your application, update the imports for RxJava 3 types also. For more information, see _What’s new_ section in RxJava 3 documentation.
+
 == Removed `onComplete` callback from write stream
 
 The `WriteStreamSubscriber.onComplete()` callback has been removed. This callback was invoked if `WriteStream` had pending streams of data to be written.