bit more docs

agorapulse · Dec 3, 2024 · 4b7b4dd · 4b7b4dd
1 parent b631ef7
commit 4b7b4dd
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/libs/micronaut-worker/src/main/java/com/agorapulse/worker/queue/QueueMessage.java b/libs/micronaut-worker/src/main/java/com/agorapulse/worker/queue/QueueMessage.java
@@ -47,8 +47,20 @@ static <T> QueueMessage<T> requeueIfDeleted(T message, Runnable doDelete, Runnab
         return DefaultQueueMessage.requeueIfDeleted(message, doDelete, doRequeue);
     }
 
+    /**
+     * Returns the payload of the message.
+     * @return the payload of the message
+     */
     T getMessage();
+
+    /**
+     * Deletes the message from the queue.
+     */
     void delete();
+
+    /**
+     * Requeues the message. Depending on the type of the message it might not be requeued if it was not deleted.
+     */
     void requeue();
 
 }