Revision 12:ab3679eb4d9d, committed 2015-07-16

Comitter:

sam_grove

Date:

Thu Jul 16 05:19:17 2015 +0000

Parent:

11:47c32687a44c

Child:

13:f84e69b3fdd3

Commit message:

Update comments

Changed in this revision

--- a/NetworkInterface.h	Wed Jul 15 23:21:17 2015 +0000
+++ b/NetworkInterface.h	Thu Jul 16 05:19:17 2015 +0000
@@ -18,7 +18,6 @@
 #define NETWORKINTERFACE_H
 
 #include "stdint.h"
-
 #include "SocketInterface.h"
 #include <map>
 
@@ -82,12 +81,14 @@
     virtual int32_t isConnected(void) const = 0;
     
     /** Allocate space for a socket.
+        @param  The type of socket you want to open, SOCK_TCP or SOCK_UDP
         @returns a pointer to the allocated socket.
      */
     virtual SocketInterface* allocateSocket(socket_protocol_t socketProtocol) const = 0;
     
     /** Deallocate space for a socket.
-        @returns a pointer to the deallocated socket.
+        @param  An allocated SocketInterface
+        @returns 0 if object is destroyed, -1 otherwise
      */
     virtual int deallocateSocket(SocketInterface* socket) const = 0;
     

--- a/SocketInterface.h	Wed Jul 15 23:21:17 2015 +0000
+++ b/SocketInterface.h	Thu Jul 16 05:19:17 2015 +0000
@@ -136,10 +136,7 @@
         @return 0 on success, -1 on failure (when an hostname cannot be resolved by DNS).
      */
     virtual int32_t close() const = 0;
-    
-protected:
-    /** The socket's unique handle number. Used to quickly create and destroy sockets within NetworkInterfaces. */
-    uint32_t handle;
+
 };
 
 #endif