Document custom channel mono for sending

References #41

Author: acogoluegnes

src/docs/asciidoc/api-guide.adoc

@@ -260,7 +260,7 @@ Each instance of `Receiver` is associated with a single instance
 of `Connection` created by the options-provided `ConnectionFactory`.
 
 A receiver is created with an instance of receiver configuration options
-`reactor.rabbitmq.ReceiverOptions`. The properties of `SenderOptions`
+`reactor.rabbitmq.ReceiverOptions`. The properties of `ReceiverOptions`
 contains the `ConnectionFactory` that creates connections to the broker
 and a Reactor `Scheduler` used for the connection creation.
 
@@ -442,6 +442,12 @@ include::{test-examples}/AdvancedFeatures.java[tag=shared-connection]
 Be aware that closing the first `Sender` or `Receiver` will close the underlying
 AMQP connection for all the others.
 
+==== Creating channels with a custom `Mono` in `Sender`
+
+`SenderOptions` provides a `channelMono` property that is called when creating the `Channel` used
+in sending methods. This is a convenient way to provide any custom logic when
+creating the `Channel`, e.g. retry logic.
+
 ==== Threading considerations for resource management
 
 A `Sender` instance maintains a `Mono<Channel>` to manage resources and by default

src/docs/asciidoc/new.adoc

@@ -1,22 +1,18 @@
 == New & Noteworthy
 
 [[new]]
+
+=== What's new in Reactor RabbitMQ 1.1
+
+* Let user provide `Mono<Channel>` for sending messages
+
 === What's new in Reactor RabbitMQ 1.0
 
-* 1.0.0.M1
-** Introduction of the `Sender` and `Receiver` API
-* 1.0.0.M2
-** Support for request/reply
-** Exception handling
-* 1.0.0.M3
-** Bump Reactor to 3.2.0.RELEASE
-** Let user provide `Mono<Channel>` for resource management
-* 1.0.0.RC1
-** Bump Reactor to 3.2.1.RELEASE
-** Bump RabbitMQ Java client to 5.5.0
-* 1.0.0.RC2
-** Bump Reactor to 3.2.3.RELEASE
-** Bump RabbitMQ Java client to 5.5.1 for better topology recovery support
-** Complete receiving flux on channel termination
-** Handle error signal of `connectionMono` subscription to enable proper error handling
-** Rename `ReactorRabbitMq` to `RabbitFlux` and `ReactorRabbitMqException` to `RabbitFluxException`
+* Introduction of the `Sender` and `Receiver` API
+* Support for request/reply
+* Exception handling
+* Let user provide `Mono<Channel>` for resource management
+* Complete receiving flux on channel termination
+* Handle error signal of `connectionMono` subscription to enable proper error handling
+* Use Reactor 3.2.3.RELEASE
+* Use Java client 5.5.1

src/main/java/reactor/rabbitmq/ChannelCloseHandlers.java

@@ -1,3 +1,19 @@
+/*
+ * Copyright (c) 2018-2019 Pivotal Software Inc, All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package reactor.rabbitmq;
 
 import com.rabbitmq.client.Channel;
@@ -7,8 +23,20 @@
 
 import java.util.function.BiConsumer;
 
+/**
+ * Helper class to close channels.
+ *
+ * @since 1.1.0
+ */
 public class ChannelCloseHandlers {
 
+    public static final BiConsumer<SignalType, Channel> SENDER_CHANNEL_CLOSE_HANDLER_INSTANCE = new SenderChannelCloseHandler();
+
+    /**
+     * Default closing strategy in {@link Sender}.
+     * <p>
+     * Closes the channel and emits a warn-level log message in case of error.
+     */
     public static class SenderChannelCloseHandler implements BiConsumer<SignalType, Channel> {
 
         private static final Logger LOGGER = LoggerFactory.getLogger(SenderChannelCloseHandler.class);

src/main/java/reactor/rabbitmq/Sender.java

@@ -92,7 +92,7 @@ public Sender(SenderOptions options) {
                 .cache();
         this.channelMono = options.getChannelMono();
         this.channelCloseHandler = options.getChannelCloseHandler() == null ?
-                new ChannelCloseHandlers.SenderChannelCloseHandler() :
+                ChannelCloseHandlers.SENDER_CHANNEL_CLOSE_HANDLER_INSTANCE :
                 options.getChannelCloseHandler();
         this.privateResourceManagementScheduler = options.getResourceManagementScheduler() == null;
         this.resourceManagementScheduler = options.getResourceManagementScheduler() == null ?

src/main/java/reactor/rabbitmq/SenderOptions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2017-2018 Pivotal Software Inc, All Rights Reserved.
+ * Copyright (c) 2017-2019 Pivotal Software Inc, All Rights Reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -39,8 +39,19 @@ public class SenderOptions {
 
     private Mono<? extends Connection> connectionMono;
 
+    /**
+     * Channel mono used in sending methods.
+     *
+     * @since 1.1.0
+     */
     private Mono<? extends Channel> channelMono;
 
+    /**
+     * Logic to close channels.
+     *
+     * @see ChannelCloseHandlers.SenderChannelCloseHandler
+     * @since 1.1.0
+     */
     private BiConsumer<SignalType, Channel> channelCloseHandler;
 
     private Scheduler resourceManagementScheduler;
@@ -106,19 +117,45 @@ public Mono<? extends Connection> getConnectionMono() {
         return connectionMono;
     }
 
+    /**
+     * Sets the channel mono to use in send methods.
+     *
+     * @param channelMono the channel mono to use
+     * @return this {@link SenderOptions} instance
+     * @since 1.1.0
+     */
     public SenderOptions channelMono(Mono<? extends Channel> channelMono) {
         this.channelMono = channelMono;
         return this;
     }
 
+    /**
+     * Returns the channel mono to use in send methods.
+     *
+     * @return
+     * @since 1.1.0
+     */
     public Mono<? extends Channel> getChannelMono() {
         return channelMono;
     }
 
+    /**
+     * Returns the channel closing logic.
+     *
+     * @return
+     * @since 1.1.0
+     */
     public BiConsumer<SignalType, Channel> getChannelCloseHandler() {
         return channelCloseHandler;
     }
 
+    /**
+     * Set the channel closing logic.
+     *
+     * @param channelCloseHandler the closing logic
+     * @return this {@link SenderOptions} instance
+     * @since 1.1.0
+     */
     public SenderOptions channelCloseHandler(BiConsumer<SignalType, Channel> channelCloseHandler) {
         this.channelCloseHandler = channelCloseHandler;
         return this;