Changes in uspace/lib/net/include/ip_interface.h [46d4d9f:e526f08] in mainline

File:

• uspace/lib/net/include/ip_interface.h (modified) (2 diffs)

uspace/lib/net/include/ip_interface.h

@@ -27 +27 @@
  */
 
-/** @addtogroup libnet 
- * @{
+/** @addtogroup ip
+ *  @{
  */
 
-#ifndef LIBNET_IP_INTERFACE_H_
-#define LIBNET_IP_INTERFACE_H_
+#ifndef __NET_IP_INTERFACE_H__
+#define __NET_IP_INTERFACE_H__
 
 #include <net/socket_codes.h>
@@ -55 +55 @@
 
 /** @name IP module interface
- * This interface is used by other modules.
+ *  This interface is used by other modules.
  */
 /*@{*/
 
 /** The transport layer notification function type definition.
- *
- * Notifies the transport layer modules about the received packet/s.
- *
- * @param[in] device_id The device identifier.
- * @param[in] packet    The received packet or the received packet queue.
- * @param[in] receiver  The receiving module service.
- * @param[in] error     The packet error reporting service. Prefixes the
- *                      received packet.
- * @return              EOK on success.
+ *  Notifies the transport layer modules about the received packet/s.
+ *  @param[in] device_id The device identifier.
+ *  @param[in] packet The received packet or the received packet queue.
+ *  @param[in] receiver The receiving module service.
+ *  @param[in] error The packet error reporting service. Prefixes the received packet.
+ *  @returns EOK on success.
  */
-typedef int (*tl_received_msg_t)(device_id_t device_id, packet_t *packet,
-    services_t receiver, services_t error);
+typedef int     (*tl_received_msg_t)(device_id_t device_id, packet_t packet, services_t receiver, services_t error);
 
-extern int ip_bind_service(services_t, int, services_t, async_client_conn_t);
-extern int ip_connect_module(services_t);
+/** Creates bidirectional connection with the ip module service and registers the message receiver.
+ *  @param[in] service The IP module service.
+ *  @param[in] protocol The transport layer protocol.
+ *  @param[in] me The requesting module service.
+ *  @param[in] receiver The message receiver. Used for remote connection.
+ *  @returns The phone of the needed service.
+ *  @returns EOK on success.
+ *  @returns Other error codes as defined for the bind_service() function.
+ */
+extern int ip_bind_service(services_t service, int protocol, services_t me, async_client_conn_t receiver);
+
+/** Connects to the IP module.
+ *  @param service The IP module service. Ignored parameter.
+ *  @returns The IP module phone on success.
+ */
+extern int ip_connect_module(services_t service);
 
 /*@}*/