From e62c171662c1fd14bf1aa0887ccb73e219f8f189 Mon Sep 17 00:00:00 2001
From: Sam Anthony <sam@samanthony.xyz>
Date: Sat, 16 Nov 2024 16:51:44 -0500
Subject: TotalOrderMulticastReceiver: javadoc

---
 .../java/derms/net/tomulticast/TotalOrderMulticastReceiver.java   | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/main/java/derms/net/tomulticast')

diff --git a/src/main/java/derms/net/tomulticast/TotalOrderMulticastReceiver.java b/src/main/java/derms/net/tomulticast/TotalOrderMulticastReceiver.java
index 16154aa..9690c38 100644
--- a/src/main/java/derms/net/tomulticast/TotalOrderMulticastReceiver.java
+++ b/src/main/java/derms/net/tomulticast/TotalOrderMulticastReceiver.java
@@ -9,6 +9,7 @@ import java.time.Duration;
 import java.util.concurrent.*;
 import java.util.logging.Logger;
 
+/** One of the receiving processes in {@link TotalOrderMulticast} group. */
 public class TotalOrderMulticastReceiver<T extends MessagePayload> {
     private static final Duration terminationTimeout = Duration.ofSeconds(1);
 
@@ -16,6 +17,12 @@ public class TotalOrderMulticastReceiver<T extends MessagePayload> {
     private final Logger log;
     private final ExecutorService pool;
 
+    /**
+     * Join the specified totally-ordered multicast group as a receiver.
+     *
+     * @param group The IP address and port of the multicast group.
+     * @param laddr The IP address of the local process.
+     */
     public TotalOrderMulticastReceiver(InetSocketAddress group, InetAddress laddr) throws IOException {
         this.deliver = new LinkedBlockingQueue<Message<T>>();
         this.log = Logger.getLogger(getClass().getName());
@@ -24,6 +31,7 @@ public class TotalOrderMulticastReceiver<T extends MessagePayload> {
         pool.execute(new Receive<T>(group, laddr, deliver));
     }
 
+    /** Close the underlying socket. */
     public void close() {
         pool.shutdownNow();
         try {
-- 
cgit v1.2.3