Document dispatching executor service

Author: acogoluegnes

src/main/java/com/rabbitmq/client/amqp/ConnectionBuilder.java

@@ -40,16 +40,17 @@ public interface ConnectionBuilder extends ConnectionSettings<ConnectionBuilder>
   /**
    * Set the executor service to use for incoming message delivery.
    *
-   * <p>The executor service is shared between the connection consumers, unless a consumer sets its
-   * own executor service with {@link ConsumerBuilder#dispatchingExecutorService(ExecutorService)}.
+   * <p>The executor service is shared between the connection consumers.
    *
-   * <p>By default, a new single-threaded executor is created.
+   * <p>By default, an executor service with {@link Runtime#availableProcessors()} thread(s) is
+   * created for the connection.
    *
    * <p>It is the developer's responsibility to shut down the executor when it is no longer needed.
    *
    * @param executorService executor service for incoming message delivery
    * @return this builder instance
-   * @see ConsumerBuilder#dispatchingExecutorService(ExecutorService)
+   * @see
+   *     com.rabbitmq.client.amqp.impl.AmqpEnvironmentBuilder#dispatchingExecutorService(ExecutorService)
    */
   ConnectionBuilder dispatchingExecutorService(ExecutorService executorService);
 

src/main/java/com/rabbitmq/client/amqp/impl/AmqpEnvironmentBuilder.java

@@ -51,6 +51,19 @@ public AmqpEnvironmentBuilder executorService(ExecutorService executorService) {
     return this;
   }
 
+  /**
+   * Set the shared executor service to use for incoming message delivery in this environment
+   * instance connections.
+   *
+   * <p>There is no shared executor service by default, each connection uses its own, see {@link
+   * ConnectionBuilder#dispatchingExecutorService(ExecutorService)}.
+   *
+   * <p>It is the developer's responsibility to shut down the executor when it is no longer needed.
+   *
+   * @param executorService the executor service for incoming message delivery
+   * @return this builder instance
+   * @see ConnectionBuilder#dispatchingExecutorService(ExecutorService)
+   */
   public AmqpEnvironmentBuilder dispatchingExecutorService(ExecutorService executorService) {
     this.dispatchingExecutorService = executorService;
     return this;