Changeset 014dd57b in mainline for uspace/lib/net/include/tl_skel.h

Timestamp:

2011-01-12T15:59:22Z (14 years ago)

Author:

Martin Decky <martin@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

ab6f2507

Parents:

797b704

Message:

streamline and create a common skeleton for the transport layer
(in the line of the previous updates to the lower layers)

File:

• uspace/lib/net/include/tl_skel.h (moved) (moved from uspace/lib/net/include/tl_local.h ) (1 diff)

uspace/lib/net/include/tl_skel.h

@@ -31 +31 @@
  */
 
-#ifndef LIBNET_TL_LOCAL_H_
-#define LIBNET_TL_LOCAL_H_
+#ifndef LIBNET_TL_SKEL_H_
+#define LIBNET_TL_SKEL_H_
 
+/** @file
+ * Transport layer module skeleton.
+ * The skeleton has to be part of each transport layer module.
+ */
+
+#include <async.h>
+#include <fibril_synch.h>
 #include <ipc/ipc.h>
-#include <async.h>
+#include <ipc/services.h>
 
-/** Starts the TL module.
+#include <adt/measured_strings.h>
+#include <net/device.h>
+#include <net/packet.h>
+
+/** Module initialization.
  *
- * Initializes the client connection serving function, initializes the module,
- * registers the module service and starts the async manager, processing IPC
- * messages in an infinite loop.
+ * This has to be implemented in user code.
  *
- * @param[in] client_connection The client connection processing function. The
- *                      module skeleton propagates its own one.
- * @return              EOK on successful module termination.
- * @return              Other error codes as defined for the module initialize
- *                      function.
- * @return              Other error codes as defined for the REGISTER_ME() macro
- *                      function.
+ * @param[in] net_phone Networking module phone.
+ *
+ * @return EOK on success.
+ * @return Other error codes as defined for each specific module
+ *         initialize function.
+ *
  */
-extern int tl_module_message_standalone(ipc_callid_t, ipc_call_t *,
+extern int tl_initialize(int net_phone);
+
+/** Process the transport layer module message.
+ *
+ * This has to be implemented in user code.
+ *
+ * @param[in]  callid Message identifier.
+ * @param[in]  call   Message parameters.
+ * @param[out] answer Answer.
+ * @param[out] count  Number of arguments of the answer.
+ *
+ * @return EOK on success.
+ * @return Other error codes as defined for each specific module.
+ *
+ */
+extern int tl_module_message(ipc_callid_t, ipc_call_t *,
     ipc_call_t *, size_t *);
 
-/** Processes the TL module 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.
- * @return              EOK on success.
- * @return              Other error codes as defined for the module's message
- *                      standalone function.
- */
-extern int tl_module_start_standalone(async_client_conn_t);
+extern int tl_module_start(int);
 
 #endif