mbed socket API

Dependents:   EthernetInterface EthernetInterface_RSF EthernetInterface EthernetInterface ... more

Deprecated

This is an mbed 2 sockets library. For mbed 5, network sockets have been revised to better support additional network stacks and thread safety here.

Revision:
8:9cf9c2d45264
Parent:
6:cd2e5559786d
Child:
10:d24738f4ef99
--- a/Socket.h	Fri Jul 27 14:22:45 2012 +0000
+++ b/Socket.h	Fri Jul 27 15:50:23 2012 +0000
@@ -32,10 +32,16 @@
 
 class TimeInterval;
 
+/** Socket file descriptor and select wrapper
+  */
 class Socket {
 public:
+    /** Socket
+     */
     Socket();
     
+    /** Close the socket file descriptor
+     */
     int close();
     
 protected:
@@ -49,10 +55,15 @@
     int select(struct timeval *timeout, bool read, bool write);
 };
 
+/** Time interval class used to specify timeouts
+ */
 class TimeInterval {
     friend class Socket;
 
 public:
+    /** Time Interval
+     \param ms time interval expressed in milliseconds
+      */
     TimeInterval(int ms);
     
 private: