EthernetNetIf Compatibility.
Dependents: XBeeWiFi_SPI_example
Fork of NetServicesSource by
Revision 6:b7dd7cde8ad2, committed 2010-07-28
- Comitter:
- donatien
- Date:
- Wed Jul 28 10:18:21 2010 +0000
- Parent:
- 5:dd63a1e02b1b
- Child:
- 7:534fa46ad8c5
- Commit message:
Changed in this revision
--- a/api/DNSRequest.h Tue Jul 27 15:59:42 2010 +0000 +++ b/api/DNSRequest.h Wed Jul 28 10:18:21 2010 +0000 @@ -59,16 +59,18 @@ public: ///Creates a new request DNSRequest(); + + ///Terminates and closes request ~DNSRequest(); ///Resolves an hostname - /* + /** @param hostname : hostname to resolve */ DNSRequestErr resolve(const char* hostname); ///Resolves an hostname - /* + /** @param host : hostname to resolve, the result will be stored in the IpAddr field of this object */ DNSRequestErr resolve(Host* pHost); @@ -95,12 +97,12 @@ } ///Gets IP address once it has been resolved - /* + /** @param pIp : pointer to an IpAddr instance in which to store the resolved IP address */ DNSRequestErr getResult(IpAddr* pIp); - ///Close DNS Request before completion + ///Closes DNS Request before completion DNSRequestErr close(); protected:
--- a/api/UDPSocket.h Tue Jul 27 15:59:42 2010 +0000 +++ b/api/UDPSocket.h Wed Jul 28 10:18:21 2010 +0000 @@ -54,9 +54,11 @@ public: ///Creates a new socket UDPSocket(); + + ///Closes and destroys socket ~UDPSocket(); //close() - ///Binds the socket to (local) host (or TODO: a multicast address) + ///Binds the socket to local host or a multicast address UDPSocketErr bind(const Host& me); ///Sends data
--- a/drv/umtsstick/UMTSStick.h Tue Jul 27 15:59:42 2010 +0000 +++ b/drv/umtsstick/UMTSStick.h Wed Jul 28 10:18:21 2010 +0000 @@ -21,6 +21,10 @@ THE SOFTWARE. */ +/** \file +UMTS Stick driver header file +*/ + #ifndef UMTS_STICK_H #define UMTS_STICK_H @@ -49,14 +53,15 @@ extern const UMTSSwitchingInfo UMTSwitchingTable[UMTS_SWITCHING_COUNT]; +///UMTS Stick error codes enum UMTSStickErr { __UMTSERR_MIN = -0xFFFF, - UMTSERR_NOTFOUND, - UMTSERR_NOTIMPLEMENTED, - UMTSERR_USBERR, - UMTSERR_DISCONNECTED, - UMTSERR_OK = 0 + UMTSERR_NOTFOUND, ///<Stick was not found + UMTSERR_NOTIMPLEMENTED, ///<This model is not implemented + UMTSERR_USBERR, ///<USB Error + UMTSERR_DISCONNECTED, ///<Stick disconnected + UMTSERR_OK = 0 ///<Success }; class UMTSStick
--- a/if/eth/EthernetNetIf.h Tue Jul 27 15:59:42 2010 +0000 +++ b/if/eth/EthernetNetIf.h Wed Jul 28 10:18:21 2010 +0000 @@ -21,6 +21,10 @@ THE SOFTWARE. */ +/** \file +Ethernet network interface header file +*/ + #ifndef ETHERNETNETIF_H #define ETHERNETNETIF_H @@ -31,11 +35,12 @@ #include "if/net/net.h" #include "if/lwip/LwipNetIf.h" +///Ethernet network interface return codes enum EthernetErr { __ETH_MIN = -0xFFFF, - ETH_TIMEOUT, ///Timeout during setup - ETH_OK = 0 + ETH_TIMEOUT, ///<Timeout during setup + ETH_OK = 0 ///<Success }; ///Ethernet network interface
--- a/if/ppp/PPPNetIf.h Tue Jul 27 15:59:42 2010 +0000 +++ b/if/ppp/PPPNetIf.h Wed Jul 28 10:18:21 2010 +0000 @@ -21,6 +21,10 @@ THE SOFTWARE. */ +/** \file +PPP Generic network interface header file +*/ + //This is a NetServer-like backend for PPP, using lwIP #ifndef PPPNETIF_H @@ -34,14 +38,15 @@ #include "drv/gprs/GPRSModem.h" #include "if/lwip/LwipNetIf.h" +///PPP connection error codes enum PPPErr { __PPP_MIN = -0xFFFF, - PPP_MODEM, //ATErr returned - PPP_NETWORK, - PPP_PROTOCOL, - PPP_CLOSED, - PPP_OK = 0 + PPP_MODEM, ///<AT error returned + PPP_NETWORK, ///<Network is down + PPP_PROTOCOL, ///<PPP Protocol error + PPP_CLOSED, ///<Connection is closed + PPP_OK = 0 ///<Success }; enum PPPStatus
--- a/if/umtsstick/UMTSStickNetIf.h Tue Jul 27 15:59:42 2010 +0000 +++ b/if/umtsstick/UMTSStickNetIf.h Wed Jul 28 10:18:21 2010 +0000 @@ -21,6 +21,10 @@ THE SOFTWARE. */ +/** \file +UMTS Stick network interface header file +*/ + #ifndef UMTSSTICKNETIF_H #define UMTSSTICKNETIF_H
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/lwip/lwipopts2.h Wed Jul 28 10:18:21 2010 +0000 @@ -0,0 +1,454 @@ +/* + * Copyright (c) 2001-2003 Swedish Institute of Computer Science. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * 3. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED + * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT + * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT + * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING + * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY + * OF SUCH DAMAGE. + * + * This file is part of the lwIP TCP/IP stack. + * + * Author: Adam Dunkels <adam@sics.se> + * + */ +#ifndef __LWIPOPTS_H__ +#define __LWIPOPTS_H__ + +#include "netCfg.h" +#if NET_LWIP_STACK + +//#include "arch/sys_arch.h" + +/* <sys/time.h> is included in cc.h! */ +#define LWIP_TIMEVAL_PRIVATE 0 + +//#define __LWIP_DEBUG +#include "dbg/dbg.h" + +#ifdef __LWIP_DEBUG + +#define LWIP_DEBUG 1 + +#define LWIP_DBG_MIN_LEVEL 0 +//#define LWIP_COMPAT_SOCKETS 1 +#define TAPIF_DEBUG LWIP_DBG_OFF +#define TUNIF_DEBUG LWIP_DBG_OFF +#define UNIXIF_DEBUG LWIP_DBG_OFF +#define DELIF_DEBUG LWIP_DBG_OFF +#define SIO_FIFO_DEBUG LWIP_DBG_OFF +#define TCPDUMP_DEBUG LWIP_DBG_OFF + +#define PPP_DEBUG LWIP_DBG_OFF +#define MEM_DEBUG LWIP_DBG_ON +#define MEMP_DEBUG LWIP_DBG_ON +#define PBUF_DEBUG LWIP_DBG_ON +#define API_LIB_DEBUG LWIP_DBG_OFF +#define API_MSG_DEBUG LWIP_DBG_OFF +#define TCPIP_DEBUG LWIP_DBG_OFF +#define NETIF_DEBUG LWIP_DBG_OFF +#define SOCKETS_DEBUG LWIP_DBG_OFF +#define DEMO_DEBUG LWIP_DBG_OFF +#define IP_DEBUG LWIP_DBG_OFF +#define IP_REASS_DEBUG LWIP_DBG_OFF +#define RAW_DEBUG LWIP_DBG_OFF +#define ICMP_DEBUG LWIP_DBG_OFF +#define UDP_DEBUG LWIP_DBG_OFF +#define TCP_DEBUG LWIP_DBG_OFF +#define TCP_INPUT_DEBUG LWIP_DBG_OFF +#define TCP_OUTPUT_DEBUG LWIP_DBG_OFF +#define TCP_RTO_DEBUG LWIP_DBG_OFF +#define TCP_CWND_DEBUG LWIP_DBG_OFF +#define TCP_WND_DEBUG LWIP_DBG_OFF +#define TCP_FR_DEBUG LWIP_DBG_OFF +#define TCP_QLEN_DEBUG LWIP_DBG_OFF +#define TCP_RST_DEBUG LWIP_DBG_OFF +#define ETHARP_DEBUG LWIP_DBG_OFF +#define DNS_DEBUG LWIP_DBG_OFF + +#endif + +/* +extern unsigned char debug_flags; +#define LWIP_DBG_TYPES_ON debug_flags +*/ +#define NO_SYS 1 +#define LWIP_SOCKET (NO_SYS==0) +#define LWIP_NETCONN (NO_SYS==0) + + +#define IP_FRAG_USES_STATIC_BUF 0 + + + +/* ---------- Memory options ---------- */ +/* MEM_ALIGNMENT: should be set to the alignment of the CPU for which + lwIP is compiled. 4 byte alignment -> define MEM_ALIGNMENT to 4, 2 + byte alignment -> define MEM_ALIGNMENT to 2. */ +/* MSVC port: intel processors don't need 4-byte alignment, + but are faster that way! */ +#define MEM_ALIGNMENT 4 + +/* MEM_SIZE: the size of the heap memory. If the application will send +a lot of data that needs to be copied, this should be set high. */ +//#define MEM_SIZE 10240 + +#if TARGET_LPC1768 + + +#define MEM_SIZE 4000 + +/// + +#define MEM_POSITION __attribute((section("AHBSRAM0"))) + +/* MEMP_NUM_PBUF: the number of memp struct pbufs. If the application + sends a lot of data out of ROM (or other static memory), this + should be set high. */ +#define MEMP_NUM_PBUF 16 +/* MEMP_NUM_RAW_PCB: the number of UDP protocol control blocks. One + per active RAW "connection". */ +//#define MEMP_NUM_RAW_PCB 3 +/* MEMP_NUM_UDP_PCB: the number of UDP protocol control blocks. One + per active UDP "connection". */ +#define MEMP_NUM_UDP_PCB 2 +/* MEMP_NUM_TCP_PCB: the number of simulatenously active TCP + connections. */ +#define MEMP_NUM_TCP_PCB 2 +/* MEMP_NUM_TCP_PCB_LISTEN: the number of listening TCP + connections. */ +#define MEMP_NUM_TCP_PCB_LISTEN 2//4 +/* MEMP_NUM_TCP_SEG: the number of simultaneously queued TCP + segments. */ +#define MEMP_NUM_TCP_SEG 16 +/* MEMP_NUM_SYS_TIMEOUT: the number of simulateously active + timeouts. */ +#define MEMP_NUM_SYS_TIMEOUT 12 + +/* The following four are used only with the sequential API and can be + set to 0 if the application only will use the raw API. */ +/* MEMP_NUM_NETBUF: the number of struct netbufs. */ +#define MEMP_NUM_NETBUF 0 +/* MEMP_NUM_NETCONN: the number of struct netconns. */ +#define MEMP_NUM_NETCONN 0 +/* MEMP_NUM_TCPIP_MSG_*: the number of struct tcpip_msg, which is used + for sequential API communication and incoming packets. Used in + src/api/tcpip.c. */ +#define MEMP_NUM_TCPIP_MSG_API 0 +#define MEMP_NUM_TCPIP_MSG_INPKT 0 + +/* ---------- Pbuf options ---------- */ +/* PBUF_POOL_SIZE: the number of buffers in the pbuf pool. */ +#define PBUF_POOL_SIZE 8//100 + +/* PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool. */ +#define PBUF_POOL_BUFSIZE 128 + +/* PBUF_LINK_HLEN: the number of bytes that should be allocated for a + link level header. */ +//#define PBUF_LINK_HLEN 16 + +/** SYS_LIGHTWEIGHT_PROT + * define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection + * for certain critical regions during buffer allocation, deallocation and memory + * allocation and deallocation. + */ +#define SYS_LIGHTWEIGHT_PROT 0 //No sys here + +/* ---------- TCP options ---------- */ +#define LWIP_TCP 1 +#define TCP_TTL 255 + +/* Controls if TCP should queue segments that arrive out of + order. Define to 0 if your device is low on memory. */ +#define TCP_QUEUE_OOSEQ 0 + +/* TCP Maximum segment size. */ +//#define TCP_MSS 1024 +#define TCP_MSS 0x276//536//0x276 + +/* TCP sender buffer space (bytes). */ +#define TCP_SND_BUF 2048 + +/* TCP sender buffer space (pbufs). This must be at least = 2 * + TCP_SND_BUF/TCP_MSS for things to work. */ +#define TCP_SND_QUEUELEN (2 * TCP_SND_BUF/TCP_MSS) + +/* TCP writable space (bytes). This must be less than or equal + to TCP_SND_BUF. It is the amount of space which must be + available in the tcp snd_buf for select to return writable */ +#define TCP_SNDLOWAT (TCP_SND_BUF/2) + +/* TCP receive window. */ +#define TCP_WND 2048 //8096 + +/* Maximum number of retransmissions of data segments. */ +//#define TCP_MAXRTX 12 + +/* Maximum number of retransmissions of SYN segments. */ +//#define TCP_SYNMAXRTX 4 + +#elif TARGET_LPC2368 + +#define MEM_POSITION __attribute((section("AHBSRAM1"))) + +/* MEMP_NUM_PBUF: the number of memp struct pbufs. If the application + sends a lot of data out of ROM (or other static memory), this + should be set high. */ +#define MEMP_NUM_PBUF 8 +/* MEMP_NUM_RAW_PCB: the number of UDP protocol control blocks. One + per active RAW "connection". */ +//#define MEMP_NUM_RAW_PCB 3 +/* MEMP_NUM_UDP_PCB: the number of UDP protocol control blocks. One + per active UDP "connection". */ +#define MEMP_NUM_UDP_PCB 2 +/* MEMP_NUM_TCP_PCB: the number of simulatenously active TCP + connections. */ +#define MEMP_NUM_TCP_PCB 2 +/* MEMP_NUM_TCP_PCB_LISTEN: the number of listening TCP + connections. */ +#define MEMP_NUM_TCP_PCB_LISTEN 2//4 +/* MEMP_NUM_TCP_SEG: the number of simultaneously queued TCP + segments. */ +#define MEMP_NUM_TCP_SEG 8 +/* MEMP_NUM_SYS_TIMEOUT: the number of simulateously active + timeouts. */ +#define MEMP_NUM_SYS_TIMEOUT 12 + +/* The following four are used only with the sequential API and can be + set to 0 if the application only will use the raw API. */ +/* MEMP_NUM_NETBUF: the number of struct netbufs. */ +#define MEMP_NUM_NETBUF 0 +/* MEMP_NUM_NETCONN: the number of struct netconns. */ +#define MEMP_NUM_NETCONN 0 +/* MEMP_NUM_TCPIP_MSG_*: the number of struct tcpip_msg, which is used + for sequential API communication and incoming packets. Used in + src/api/tcpip.c. */ +#define MEMP_NUM_TCPIP_MSG_API 0 +#define MEMP_NUM_TCPIP_MSG_INPKT 0 + +/* ---------- Pbuf options ---------- */ +/* PBUF_POOL_SIZE: the number of buffers in the pbuf pool. */ +#define PBUF_POOL_SIZE 8//16//100 + +/* PBUF_POOL_BUFSIZE: the size of each pbuf in the pbuf pool. */ +//#define PBUF_POOL_BUFSIZE 128 + +/* PBUF_LINK_HLEN: the number of bytes that should be allocated for a + link level header. */ +//#define PBUF_LINK_HLEN 16 + +/** SYS_LIGHTWEIGHT_PROT + * define SYS_LIGHTWEIGHT_PROT in lwipopts.h if you want inter-task protection + * for certain critical regions during buffer allocation, deallocation and memory + * allocation and deallocation. + */ +#define SYS_LIGHTWEIGHT_PROT 0 //No sys here + +/* ---------- TCP options ---------- */ +#define LWIP_TCP 1 +#define TCP_TTL 255 + +/* Controls if TCP should queue segments that arrive out of + order. Define to 0 if your device is low on memory. */ +#define TCP_QUEUE_OOSEQ 0 + +/* TCP Maximum segment size. */ +//#define TCP_MSS 1024 +#define TCP_MSS 512//0x276//536//0x276 + +/* TCP sender buffer space (bytes). */ +#define TCP_SND_BUF 1024//2048 + +/* TCP sender buffer space (pbufs). This must be at least = 2 * + TCP_SND_BUF/TCP_MSS for things to work. */ +#define TCP_SND_QUEUELEN (4 * TCP_SND_BUF/TCP_MSS)//(4 * TCP_SND_BUF/TCP_MSS) + +/* TCP writable space (bytes). This must be less than or equal + to TCP_SND_BUF. It is the amount of space which must be + available in the tcp snd_buf for select to return writable */ +#define TCP_SNDLOWAT (TCP_SND_BUF/2) + +/* TCP receive window. */ +#define TCP_WND 512 //8096 + +/* Maximum number of retransmissions of data segments. */ +//#define TCP_MAXRTX 12 + +/* Maximum number of retransmissions of SYN segments. */ +//#define TCP_SYNMAXRTX 4 + +#endif + +/* ---------- ARP options ---------- */ +#define LWIP_ARP (NET_ETH | NET_ZG2100) +#define ARP_TABLE_SIZE 2//4//10 +#define ARP_QUEUEING 0//1 +#define ETHARP_TRUST_IP_MAC 1 + +/* ---------- IP options ---------- */ +/* Define IP_FORWARD to 1 if you wish to have the ability to forward + IP packets across network interfaces. If you are going to run lwIP + on a device with only one network interface, define this to 0. */ +#define IP_FORWARD 0 + + +/* IP reassembly and segmentation.These are orthogonal even + * if they both deal with IP fragments */ + /* +#define IP_REASSEMBLY 1 +#define IP_REASS_MAX_PBUFS 10 +#define MEMP_NUM_REASSDATA 10 +#define IP_FRAG 1 +*/ +/* ---------- ICMP options ---------- */ +#define ICMP_TTL 255 + +/* ---------- DHCP options ---------- */ +/* Define LWIP_DHCP to 1 if you want DHCP configuration of + interfaces. */ +#define LWIP_DHCP (NET_ETH | NET_ZG2100) + +/* 1 if you want to do an ARP check on the offered address + (recommended if using DHCP). */ +#define DHCP_DOES_ARP_CHECK (LWIP_DHCP) + +/* ---------- AUTOIP options ------- */ +#define LWIP_AUTOIP 0 + +/* ---------- SNMP options ---------- */ +/** @todo SNMP is experimental for now + @note UDP must be available for SNMP transport */ +#ifndef LWIP_SNMP +#define LWIP_SNMP 0 +#endif + + +#ifndef SNMP_PRIVATE_MIB +#define SNMP_PRIVATE_MIB 0 +#endif + + +/* ---------- UDP options ---------- */ +#define LWIP_UDP 1 +#define UDP_TTL 255 + +/* ---------- DNS options ---------- */ +#define LWIP_DNS 1 + +/* ---------- RAW options ---------- */ +#define LWIP_RAW 0 +#define RAW_TTL 255 + +/* ---------- Statistics options ---------- */ +/* individual STATS options can be turned off by defining them to 0 + * (e.g #define TCP_STATS 0). All of them are turned off if LWIP_STATS + * is 0 + * */ + +#define LWIP_STATS 0 + +/* ---------- PPP options ---------- */ + +#define PPP_SUPPORT NET_PPP /* Set > 0 for PPP */ + +#if PPP_SUPPORT > 0 + +#define NUM_PPP 1 /* Max PPP sessions. */ + + +/* Select modules to enable. Ideally these would be set in the makefile but + * we're limited by the command line length so you need to modify the settings + * in this file. + */ +#define PAP_SUPPORT 1 /* Set > 0 for PAP. */ +#define CHAP_SUPPORT 1 /* Set > 0 for CHAP. */ +#define MSCHAP_SUPPORT 0 /* Set > 0 for MSCHAP (NOT FUNCTIONAL!) */ +#define CBCP_SUPPORT 0 /* Set > 0 for CBCP (NOT FUNCTIONAL!) */ +#define CCP_SUPPORT 0 /* Set > 0 for CCP (NOT FUNCTIONAL!) */ +#define VJ_SUPPORT 1 /* Set > 0 for VJ header compression. */ +#define MD5_SUPPORT 1 /* Set > 0 for MD5 (see also CHAP) */ + + +/* + * Timeouts. + */ +#define FSM_DEFTIMEOUT 6 /* Timeout time in seconds */ +#define FSM_DEFMAXTERMREQS 2 /* Maximum Terminate-Request transmissions */ +#define FSM_DEFMAXCONFREQS 10 /* Maximum Configure-Request transmissions */ +#define FSM_DEFMAXNAKLOOPS 5 /* Maximum number of nak loops */ + +#define UPAP_DEFTIMEOUT 6 /* Timeout (seconds) for retransmitting req */ +#define UPAP_DEFREQTIME 30 /* Time to wait for auth-req from peer */ + +#define CHAP_DEFTIMEOUT 6 /* Timeout time in seconds */ +#define CHAP_DEFTRANSMITS 10 /* max # times to send challenge */ + + +/* Interval in seconds between keepalive echo requests, 0 to disable. */ +#if 1 +#define LCP_ECHOINTERVAL 0 +#else + +#define LCP_ECHOINTERVAL 10 +#endif + + +/* Number of unanswered echo requests before failure. */ +#define LCP_MAXECHOFAILS 3 + +/* Max Xmit idle time (in jiffies) before resend flag char. */ +#define PPP_MAXIDLEFLAG 0//Send it every time//100 + +/* + * Packet sizes + * + * Note - lcp shouldn't be allowed to negotiate stuff outside these + * limits. See lcp.h in the pppd directory. + * (XXX - these constants should simply be shared by lcp.c instead + * of living in lcp.h) + */ +#define PPP_MTU 1500 /* Default MTU (size of Info field) */ +#if 0 +#define PPP_MAXMTU 65535 - (PPP_HDRLEN + PPP_FCSLEN) +#else + +#define PPP_MAXMTU 1500 /* Largest MTU we allow */ +#endif + +#define PPP_MINMTU 64 +#define PPP_MRU 1500 /* default MRU = max length of info field */ +#define PPP_MAXMRU 1500 /* Largest MRU we allow */ +#define PPP_DEFMRU 296 /* Try for this */ +#define PPP_MINMRU 128 /* No MRUs below this */ + + +#define MAXNAMELEN 64 /* max length of hostname or name for auth */ +#define MAXSECRETLEN 64 /* max length of password or secret */ + +#endif /* PPP_SUPPORT > 0 */ + +//C++ Compat +#define try vTry + +#endif + + +#endif /* __LWIPOPTS_H__ */
--- a/services/http/client/HTTPClient.h Tue Jul 27 15:59:42 2010 +0000 +++ b/services/http/client/HTTPClient.h Wed Jul 28 10:18:21 2010 +0000 @@ -21,6 +21,10 @@ THE SOFTWARE. */ +/** \file +HTTP Client header file +*/ + #ifndef HTTP_CLIENT_H #define HTTP_CLIENT_H @@ -41,16 +45,16 @@ ///HTTP client results enum HTTPResult { - HTTP_OK, - HTTP_PROCESSING, - HTTP_PARSE, ///URI Parse error - HTTP_DNS, ///Could not resolve name - HTTP_PRTCL, ///Protocol error - HTTP_NOTFOUND, ///HTTP 404 Error - HTTP_REFUSED, ///HTTP 403 Error - HTTP_ERROR, ///HTTP xxx error - HTTP_TIMEOUT, ///Connection timeout - HTTP_CONN ///Connection error + HTTP_OK, ///<Success + HTTP_PROCESSING, ///<Processing + HTTP_PARSE, ///<URI Parse error + HTTP_DNS, ///<Could not resolve name + HTTP_PRTCL, ///<Protocol error + HTTP_NOTFOUND, ///<HTTP 404 Error + HTTP_REFUSED, ///<HTTP 403 Error + HTTP_ERROR, ///<HTTP xxx error + HTTP_TIMEOUT, ///<Connection timeout + HTTP_CONN ///<Connection error }; ///A simple HTTP Client
--- a/services/http/server/HTTPServer.h Tue Jul 27 15:59:42 2010 +0000 +++ b/services/http/server/HTTPServer.h Wed Jul 28 10:18:21 2010 +0000 @@ -21,6 +21,10 @@ THE SOFTWARE. */ +/** \file +HTTP Server header file +*/ + #ifndef HTTP_SERVER_H #define HTTP_SERVER_H
--- a/services/mysql/MySQLClient.h Tue Jul 27 15:59:42 2010 +0000 +++ b/services/mysql/MySQLClient.h Wed Jul 28 10:18:21 2010 +0000 @@ -21,6 +21,10 @@ THE SOFTWARE. */ +/** \file +MySQL Client header file +*/ + #ifndef MYSQL_CLIENT_H #define MYSQL_CLIENT_H @@ -40,16 +44,16 @@ ///MySQL client results enum MySQLResult { - MYSQL_OK, - MYSQL_PROCESSING, - MYSQL_PRTCL, - MYSQL_SETUP, ///Not properly configured - MYSQL_DNS, ///Could not resolve name - MYSQL_AUTHFAILED, ///Auth failure - MYSQL_READY, ///Ready to send commands - MYSQL_SQL, ///SQL Error - MYSQL_TIMEOUT, ///Connection timeout - MYSQL_CONN ///Connection error + MYSQL_OK, ///<Success + MYSQL_PROCESSING, ///<Processing + MYSQL_PRTCL, ///<Protocol error + MYSQL_SETUP, ///<Not properly configured + MYSQL_DNS, ///<Could not resolve name + MYSQL_AUTHFAILED, ///<Auth failure + MYSQL_READY, ///<Ready to send commands + MYSQL_SQL, ///<SQL Error + MYSQL_TIMEOUT, ///<Connection timeout + MYSQL_CONN ///<Connection error }; ///A MySQL Client
--- a/services/ntp/NTPClient.h Tue Jul 27 15:59:42 2010 +0000 +++ b/services/ntp/NTPClient.h Wed Jul 28 10:18:21 2010 +0000 @@ -21,6 +21,10 @@ THE SOFTWARE. */ +/** \file +NTP Client header file +*/ + #ifndef NTP_CLIENT_H #define NTP_CLIENT_H @@ -32,11 +36,11 @@ ///NTP Client results enum NTPResult { - NTP_OK, - NTP_PROCESSING, - NTP_PRTCL, ///Protocol error - NTP_TIMEOUT, ///Connection timeout - NTP_DNS ///Could not resolve DNS Addr + NTP_OK, ///<Success + NTP_PROCESSING, ///<Processing + NTP_PRTCL, ///<Protocol error + NTP_TIMEOUT, ///<Connection timeout + NTP_DNS ///<Could not resolve DNS hostname }; ///A NTP Client