From 56f8160af8e89e6981a5f67d23c307dcd1ef0f2a Mon Sep 17 00:00:00 2001
From: Grant Limberg <glimberg@gmail.com>
Date: Sat, 25 Apr 2015 17:29:07 -0700
Subject: generate javadocs for the Java SDK

---
 java/src/com/zerotierone/sdk/PacketSender.java | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

(limited to 'java/src/com/zerotierone/sdk/PacketSender.java')

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);
 }
-- 
cgit v1.2.3