pefect / NetworkSocketAPI

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.

Dependencies:   DnsQuery

Dependents:   WizFi310_TCP_Echo_Server_Example

Fork of NetworkSocketAPI by NetworkSocketAPI

Diff: NetworkInterface.h

Revision:
12:ab3679eb4d9d
Parent:
11:47c32687a44c
Child:
13:f84e69b3fdd3
diff -r 47c32687a44c -r ab3679eb4d9d NetworkInterface.h
--- 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;