--- a/src/Network/UDP.hh Fri Jan 16 21:24:45 2009 +0200
+++ b/src/Network/UDP.hh Fri Jan 16 22:03:49 2009 +0200
@@ -1,6 +1,12 @@
#ifndef NETWORK_UDP_HH
#define NETWORK_UDP_HH
+/**
+ * @file
+ *
+ * UDP implementation
+ */
+
#include "Socket.hh"
#include "Address.hh"
#include "Packet.hh"
@@ -44,6 +50,9 @@
public:
/**
* Send the given packet on this UDP socket to the given destination address
+ *
+ * @return true if the packet was passed on to the socket API, false if the socket was busy and the packet was
+ * dropped (no chance of it arriving).
*/
bool sendto (const NetworkPacketBuffer &packet, const NetworkAddress &dst);