From a0ae7a9c8a57ebf065579d33a5972a57adefb7ff Mon Sep 17 00:00:00 2001 From: Janus Varmarken Date: Wed, 18 Jul 2018 21:35:24 -0700 Subject: [PATCH] Javadoc for PcapHandleReader constructor. --- .../edu/uci/iotproject/analysis/PcapHandleReader.java | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/Code/Projects/SmartPlugDetector/src/main/java/edu/uci/iotproject/analysis/PcapHandleReader.java b/Code/Projects/SmartPlugDetector/src/main/java/edu/uci/iotproject/analysis/PcapHandleReader.java index a0d28d2..968f5de 100644 --- a/Code/Projects/SmartPlugDetector/src/main/java/edu/uci/iotproject/analysis/PcapHandleReader.java +++ b/Code/Projects/SmartPlugDetector/src/main/java/edu/uci/iotproject/analysis/PcapHandleReader.java @@ -17,6 +17,16 @@ public class PcapHandleReader { private final PcapHandle mHandle; private final PacketListener[] mPacketListeners; + /** + * Create a {@code PcapHandleReader}. + * @param handle An open {@link PcapHandle} that packets will be read from. + * @param packetFilter A {@link PcapPacketFilter} that dictates which of the packets read from {@code handle} should + * be delivered to {@code packetListeners}. Note that while a value of {@code null} is not + * permitted here, the caller can instead simply provide an implementation that always returns + * {@code true} if they want to include all packets read from {@code handle}. + * @param packetListeners One or more {@link PacketListener}s to which those packets read from {@code handle} that + * pass through {@code packetFilter} are delivered. + */ public PcapHandleReader(PcapHandle handle, PcapPacketFilter packetFilter, PacketListener... packetListeners) { mHandle = handle; mPacketFilter = packetFilter; -- 2.34.1