Diff: io/IPStack.h

Revision:

45:40745c2036cf

Parent:

36:bb6b293c7495

Child:

46:b30547bf07d5

diff -r 4739e039421a -r 40745c2036cf io/IPStack.h
--- a/io/IPStack.h	Thu Dec 19 16:54:09 2013 +0000
+++ b/io/IPStack.h	Thu Dec 19 21:38:01 2013 +0000
@@ -50,7 +50,8 @@
     * This socket connection is established using the devices built in IP stack.
     *
     * @param address is the address you want to connect to in the form of xxx.xxx.xxx.xxx
-    * or a URL.
+    * or a URL. If using a URL make sure the device supports DNS and is properly configured
+    * for that mode.
     * @param port the remote port you want to connect to.
     * @param mode an enum that specifies whether this socket connection is type TCP or UDP.
     * @returns true if the connection was successfully opened, otherwise false.
@@ -74,7 +75,7 @@
     *
     * @param data a pointer to the data buffer that will be filled with the read data.
     * @param max the maximum number of bytes to attempt to read, typically the same as
-    * the size of data.
+    * the size of the passed in data buffer.
     * @param timeout the amount of time in milliseconds to wait in trying to read the max
     * number of bytes. If set to -1 the call blocks until it receives the max number of bytes
     * or encounters and error.
@@ -105,7 +106,7 @@
 
     /** This method is used to get the space available to write bytes to the socket.
     *
-    * @returns the number of bytes that can be written, 0 if the write buffer is full.
+    * @returns the number of bytes that can be written, 0 if unable to write.
     */
     virtual unsigned int writeable() = 0;