This is an automated email from the ASF dual-hosted git repository. cdutz pushed a commit to branch develop in repository https://gitbox.apache.org/repos/asf/plc4x.git
commit 7d0b94df6e00df9530c0fac164068ae85fc5f0db Author: Christofer Dutz <[email protected]> AuthorDate: Wed Oct 22 08:35:16 2025 +0200 docs: Added a bit more documentation to the previously undocumented PlcSubscriber methods. --- .../org/apache/plc4x/java/spi/messages/PlcSubscriber.java | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/PlcSubscriber.java b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/PlcSubscriber.java index 15d7ab23e8..5d67492086 100644 --- a/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/PlcSubscriber.java +++ b/plc4j/spi/src/main/java/org/apache/plc4x/java/spi/messages/PlcSubscriber.java @@ -49,14 +49,21 @@ public interface PlcSubscriber { CompletableFuture<PlcUnsubscriptionResponse> unsubscribe(PlcUnsubscriptionRequest unsubscriptionRequest); /** - * @param consumer - * @param handles - * @return TODO: document me + * This method is used to register a consumer for a set of subscription handles. This is generally used if the + * user didn't pre-register consumers when creating the subscription request. In this case the consumer will + * use the DefaultPlcSubscriptionHandle.register() method to register after the subscription request has been + * executed. + * + * @param consumer consumer to register. + * @param handles handle for which to register the consumer. + * @return registration object. */ PlcConsumerRegistration register(Consumer<PlcSubscriptionEvent> consumer, Collection<PlcSubscriptionHandle> handles); /** - * // TODO: document me. + * Allows manually unregistering a consumer. + * + * @param registration registration object returned by the register method. */ void unregister(PlcConsumerRegistration registration);
