Changes in uspace/srv/net/tl/tcp/tcp_module.h [89e57cee:14f1db0] in mainline

File:

• uspace/srv/net/tl/tcp/tcp_module.h (modified) (1 diff)

uspace/srv/net/tl/tcp/tcp_module.h

@@ -28 +28 @@
 
 /** @addtogroup tcp
- * @{
+ *  @{
  */
 
 /** @file
- * TCP module functions.
- * The functions are used as TCP module entry points.
+ *  TCP module functions.
+ *  The functions are used as TCP module entry points.
  */
 
-#ifndef NET_TCP_MODULE_H_
-#define NET_TCP_MODULE_H_
+#ifndef __NET_TCP_MODULE_H__
+#define __NET_TCP_MODULE_H__
 
 #include <async.h>
 #include <ipc/ipc.h>
 
-extern int tcp_initialize(async_client_conn_t);
-extern int tcp_message_standalone(ipc_callid_t, ipc_call_t *, ipc_call_t *,
-    int *);
+/** Initializes the TCP module.
+ *  @param[in] client_connection The client connection processing function. The module skeleton propagates its own one.
+ *  @returns EOK on success.
+ *  @returns ENOMEM if there is not enough memory left.
+ */
+extern int tcp_initialize(async_client_conn_t client_connection);
+
+/** Processes the TCP message.
+ *  @param[in] callid The message identifier.
+ *  @param[in] call The message parameters.
+ *  @param[out] answer The message answer parameters.
+ *  @param[out] answer_count The last parameter for the actual answer in the answer parameter.
+ *  @returns EOK on success.
+ *  @returns ENOTSUP if the message is not known.
+ *  @see tcp_interface.h
+ *  @see IS_NET_TCP_MESSAGE()
+ */
+extern int tcp_message_standalone(ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count);
 
 #endif