Merge branch 'sched'

[paraslash.git] / dccp.c

diff --git a/dccp.c b/dccp.c
index b5cf7fd9abd106a5c942c96f0cab9e53445d12de..147e46307676b60025561e4f81167a3a72b22b90 100644 (file)
--- a/dccp.c
+++ b/dccp.c
@@ -16,6 +16,8 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
+/** \file dccp.c common functions of the dccp sender/receiver */
+
 /*
  * based on common.c of dccp-cs-0.01.tar.bz2,
  * (C) 2005 Ian McDonald <imcdnzl@gmail.com>
@@ -25,6 +27,20 @@
 #include "error.h"
 #include "dccp.h"
 
+/** \cond some magic dccp constants */
+#define SOL_DCCP 269
+#define SOCK_DCCP 6
+#define IPPROTO_DCCP 33
+#define DCCP_SOCKOPT_PACKET_SIZE 1
+#define DCCP_SOCKOPT_SERVICE 2
+/** \endcond */
+
+/**
+ * obtain a dccp socket for sending/receiving
+ *
+ * \return the file descriptor of the new socket or \p -E_DCCP_SOCKET
+ * on errors.
+ */
 int dccp_get_socket(void)
 {
        int s = socket(AF_INET, SOCK_DCCP, IPPROTO_DCCP);
@@ -34,6 +50,13 @@ int dccp_get_socket(void)
        return s;
 }
 
+/**
+ * prepare a dccp socket
+ *
+ * \param fd the file descriptor of the socket
+ *
+ * \returns positive on success, negative on errors.
+ */
 int dccp_set_socket(int fd)
 {
        int pkt_size = 256, ret;