Socket - mbed socket API

Users » mbed_official » Code » Socket

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.

Diff: UDPPacket.h

Revision:: 8:9cf9c2d45264
Parent:: 5:300e7ad2dc1d

--- a/UDPPacket.h	Fri Jul 27 14:22:45 2012 +0000
+++ b/UDPPacket.h	Fri Jul 27 15:50:23 2012 +0000
@@ -24,13 +24,23 @@
 // Forward declaration
 class UDPSocket;
 
+/** UDP Packet
+  */
 class UDPPacket : public Endpoint {
     friend class UDPSocket;
 
 public:
+    /** UDP Packet
+      \param buffer   Pointer to the data buffer for this packet
+      \param length   length of the data buffer
+      */
     UDPPacket(char* buffer, unsigned int length);
     ~UDPPacket() {}
     
+    /** Set the data buffer for this packet
+      \param buffer   Pointer to the data buffer for this packet
+      \param length   length of the data buffer
+      */
     void set_data(char* buffer, unsigned int length);
 
 private: