Document why InboundMappingSink and OutboundMappingProcessorActor tak…

…e multiple mapping processors to create. Signed-off-by: Yufei Cai <yufei.cai@bosch.io>
eclipse-ditto · Dec 30, 2021 · 506ebd0 · 506ebd0
1 parent 967904d
commit 506ebd0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/...ce/src/main/java/org/eclipse/ditto/connectivity/service/messaging/InboundMappingSink.java b/...ce/src/main/java/org/eclipse/ditto/connectivity/service/messaging/InboundMappingSink.java
@@ -78,7 +78,8 @@ private InboundMappingSink(final List<InboundMappingProcessor> inboundMappingPro
     /**
      * Creates a Sink which is responsible for inbound payload mapping.
      *
-     * @param inboundMappingProcessors the MessageMappingProcessors to use for inbound messages.
+     * @param inboundMappingProcessors the MessageMappingProcessors to use for inbound messages. If at least as many
+     * processors are given as `processorPoolSize`, then each processor is guaranteed to be invoked sequentially.
      * @param connectionId the connectionId
      * @param processorPoolSize how many message processing may happen in parallel per direction (incoming or outgoing).
      * @param inboundDispatchingSink used to dispatch inbound signals.

diff --git a/.../java/org/eclipse/ditto/connectivity/service/messaging/OutboundMappingProcessorActor.java b/.../java/org/eclipse/ditto/connectivity/service/messaging/OutboundMappingProcessorActor.java
@@ -217,7 +217,8 @@ private int determinePoolSize(final int connectionPoolSize, final int maxPoolSiz
      * Creates Akka configuration object for this actor.
      *
      * @param clientActor the client actor that created this mapping actor.
-     * @param outboundMappingProcessors the MessageMappingProcessors to use for outbound messages.
+     * @param outboundMappingProcessors the MessageMappingProcessors to use for outbound messages. If at least as many
+     * processors are given as `processorPoolSize`, then each processor is guaranteed to be invoked sequentially.
      * @param connection the connection.
      * @param connectivityConfig the config of the connectivity service with potential overwrites.
      * @param processorPoolSize how many message processing may happen in parallel per direction (incoming or outgoing).