Neal Horman / Socket

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of Socket by mbed official

Diff: Socket.h

Revision:
8:9cf9c2d45264
Parent:
6:cd2e5559786d
--- 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: