GainSpan Wi-Fi library

Diff: GSwifi.h

Revision:

6:a423f0d197de

Parent:

5:6def1d0df519

Child:

7:b75b7fc144ff

--- a/GSwifi.h	Fri Jul 13 04:14:14 2012 +0000
+++ b/GSwifi.h	Thu Aug 16 05:01:19 2012 +0000
@@ -181,16 +181,12 @@
      * resolv hostname
      * @param name hostname
      * @param addr resolved ip address
-     * @retval 0 success
-     * @retval -1 failure
      */
     int getHostByName (const char* name, IpAddr &addr);
     /**
      * resolv hostname
      * @param host.name hostname
      * @param host.ipaddr resolved ip address
-     * @retval 0 success
-     * @retval -1 failure
      */
     int getHostByName (Host &host);
     /**
@@ -200,8 +196,8 @@
     int setRFPower (int power);
     /**
      * power save mode
-     * @param active 0:switched off, 1:always on
-     * @param save 0:disable, 1:enable
+     * @param active rx radio 0:switched off, 1:always on
+     * @param save power save 0:disable, 1:enable
      */
     int powerSave (int active, int save);
     /**
@@ -230,21 +226,31 @@
     GSSTATUS getStatus ();
     /**
      * RSSI
-     * @return dBm
+     * @return RSSI (dBm)
      */
     int getRssi ();
     /**
      * set NTP server
+     * @param host SNTP server
+     * @param sec time sync interval, 0:one time
      */
     int ntpdate (Host host, int sec = 0);
     /**
-     * set RTC time
+     * set system time
+     * @param time date time (UTC)
      */
     int setTime (time_t time);
-    /*
+    /**
      * get RTC time
+     * @return date time (UTC)
      */
     time_t getTime ();
+    /**
+     * GPIO output
+     * @param port 10,11,30,31
+     * @param out 0:set(high), 1:reset(low)
+     */
+    int gpioOut (int port, int out);
 
     /**
      * main polling
@@ -253,10 +259,12 @@
 
     /**
      * tcp/udp client
+     * @return CID, -1:failure
      */
     int open (Host &host, GSPROTOCOL pro, onGsReceiveFunc ponGsReceive = NULL);
     /**
      * tcp/udp server
+     * @return CID, -1:failure
      */
     int listen (int port, GSPROTOCOL pro, onGsReceiveFunc ponGsReceive = NULL);
     /**
@@ -273,10 +281,12 @@
     int send (int cid, char *buf, int len, Host &host);
     /**
      * recv data tcp(s/c), udp(c)
+     * @return length
      */
     int recv (int cid, char *buf, int len);
     /**
      * recv data udp(s)
+     * @return length
      */
     int recv (int cid, char *buf, int len, Host &host);
     /**
@@ -286,6 +296,8 @@
 
     /**
      * http request
+     * @return CID, -1:failure
+     * If you use ssl, please set system time.
      */
     int httpGet (Host &host, char *uri, int ssl = 0, onGsReceiveFunc ponGsReceive = NULL);
     /**