summaryrefslogtreecommitdiff
path: root/java/src/com/zerotierone/sdk/PacketSender.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/src/com/zerotierone/sdk/PacketSender.java')
-rw-r--r--java/src/com/zerotierone/sdk/PacketSender.java18
1 files changed, 15 insertions, 3 deletions
diff --git a/java/src/com/zerotierone/sdk/PacketSender.java b/java/src/com/zerotierone/sdk/PacketSender.java
index 572e1807..0c1cd83e 100644
--- a/java/src/com/zerotierone/sdk/PacketSender.java
+++ b/java/src/com/zerotierone/sdk/PacketSender.java
@@ -26,12 +26,24 @@
*/
package com.zerotierone.sdk;
-import java.nio.ByteBuffer;
+import java.net.InetAddress;
public interface PacketSender {
+ /**
+ * Function to send a ZeroTier packet out over the wire
+ *
+ * <p>The function must return zero on success and may return any error code
+ * on failure. Note that success does not (of course) guarantee packet
+ * delivery. It only means that the packet appears to have been sent.</p>
+ *
+ * @param addr {@link InetAddress} to send to
+ * @param linkDesperation
+ * @param packetData data to send
+ * @return 0 on success, any error code on failure.
+ */
public int onSendPacketRequested(
- String addr,
- int linkDesparation,
+ InetAddress addr,
+ int linkDesperation,
byte[] packetData);
}