From 60a0bc50938f9643ec5230b1748abb370e86b410 Mon Sep 17 00:00:00 2001
From: kento2 <kento@placeq.com>
Date: Tue, 7 Jul 2026 08:31:54 +0200
Subject: [PATCH] doc

---
 .../scrowlib/messaging/MessageBroker.java       | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/core-lib/src/main/java/de/kentoj/scrowlib/messaging/MessageBroker.java b/core-lib/src/main/java/de/kentoj/scrowlib/messaging/MessageBroker.java
index b837d28..b351ca4 100644
--- a/core-lib/src/main/java/de/kentoj/scrowlib/messaging/MessageBroker.java
+++ b/core-lib/src/main/java/de/kentoj/scrowlib/messaging/MessageBroker.java
@@ -22,10 +22,20 @@ public class MessageBroker {
         this.dispatcher = nats.createDispatcher();
     }
 
+    /**
+     * Runs blocking.
+     * publishes to the message broker
+     * @param subject <a href="https://docs.nats.io/nats-concepts/subjects">subject</a> to publish to
+     */
     public void publish(String subject, Document document) {
         nats.publish(subject, DocumentRepository.toBytes(document));
     }
-
+  
+    /**
+     * Runs blocking.
+     * publishes to the message broker
+     * @param subject <a href="https://docs.nats.io/nats-concepts/subjects">subject</a> to publish to
+     */
     public void publish(String subject, Result<Document, String> result) {
         this.publish(subject, ResultRepository.toDocument(result));
     }
@@ -54,6 +64,11 @@ public class MessageBroker {
         });
     }
 
+    /**
+     * Runs blocking.
+     * Executes a RPC call: The document is published and this method starts listening for incoming
+     * replies. The returned Result holds either a document with the requested data, or an error as a string
+    */
     public Result<Document, String> request(String subject, Document document) {
         var response = nats.request(subject, DocumentRepository.toBytes(document)).join();
         return ResultRepository.fromDocument(DocumentRepository.fromMessage(response));