Changeset dfda6a1 in mainline for uspace/lib/net/tl/icmp_remote.c

Timestamp:

2010-10-23T20:28:55Z (13 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

cc8d91a

Parents:

33dbbd2 (diff), 018d79b8 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge from lp:~jakub/helenos/net.

File:

• uspace/lib/net/tl/icmp_remote.c (modified) (3 diffs)

uspace/lib/net/tl/icmp_remote.c

@@ -27 +27 @@
  */
 
-/** @addtogroup icmp
+/** @addtogroup libnet
  *  @{
  */
 
 /** @file
- *  ICMP interface implementation for remote modules.
- *  @see icmp_interface.h
+ * ICMP interface implementation for remote modules.
+ * @see icmp_interface.h
  */
+
+#include <icmp_interface.h>
+#include <net/modules.h>
+#include <packet_client.h>
 
 #include <async.h>
@@ -43 +47 @@
 #include <sys/types.h>
 
-#include <net/modules.h>
-#include <icmp_interface.h>
-#include <packet_client.h>
-
-int icmp_destination_unreachable_msg(int icmp_phone, icmp_code_t code, icmp_param_t mtu, packet_t packet){
-        async_msg_3(icmp_phone, NET_ICMP_DEST_UNREACH, (ipcarg_t) code, (ipcarg_t) packet_get_id(packet), (ipcarg_t) mtu);
+/** Sends the Destination Unreachable error notification packet.
+ *
+ * Beginning of the packet is sent as the notification packet data.
+ * The source and the destination addresses should be set in the original
+ * packet.
+ *
+ * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls.
+ * @param[in] code      The error specific code.
+ * @param[in] mtu       The error MTU value.
+ * @param[in] packet    The original packet.
+ * @returns             EOK on success.
+ * @returns             EPERM if the ICMP error notifications are disabled.
+ * @returns             ENOMEM if there is not enough memory left.
+ */
+int
+icmp_destination_unreachable_msg(int icmp_phone, icmp_code_t code,
+    icmp_param_t mtu, packet_t packet)
+{
+        async_msg_3(icmp_phone, NET_ICMP_DEST_UNREACH, (ipcarg_t) code,
+            (ipcarg_t) packet_get_id(packet), (ipcarg_t) mtu);
         return EOK;
 }
 
-int icmp_source_quench_msg(int icmp_phone, packet_t packet){
-        async_msg_2(icmp_phone, NET_ICMP_SOURCE_QUENCH, 0, (ipcarg_t) packet_get_id(packet));
+/** Sends the Source Quench error notification packet.
+ *
+ * Beginning of the packet is sent as the notification packet data.
+ * The source and the destination addresses should be set in the original
+ * packet.
+ *
+ * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls.
+ * @param[in] packet    The original packet.
+ * @returns             EOK on success.
+ * @returns             EPERM if the ICMP error notifications are disabled.
+ * @returns             ENOMEM if there is not enough memory left.
+ */
+int icmp_source_quench_msg(int icmp_phone, packet_t packet)
+{
+        async_msg_2(icmp_phone, NET_ICMP_SOURCE_QUENCH, 0,
+            (ipcarg_t) packet_get_id(packet));
         return EOK;
 }
 
-int icmp_time_exceeded_msg(int icmp_phone, icmp_code_t code, packet_t packet){
-        async_msg_2(icmp_phone, NET_ICMP_TIME_EXCEEDED, (ipcarg_t) code, (ipcarg_t) packet_get_id(packet));
+/** Sends the Time Exceeded error notification packet.
+ *
+ * Beginning of the packet is sent as the notification packet data.
+ * The source and the destination addresses should be set in the original
+ * packet.
+ *
+ * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls.
+ * @param[in] code      The error specific code.
+ * @param[in] packet    The original packet.
+ * @returns             EOK on success.
+ * @returns             EPERM if the ICMP error notifications are disabled.
+ * @returns             ENOMEM if there is not enough memory left.
+ */
+int icmp_time_exceeded_msg(int icmp_phone, icmp_code_t code, packet_t packet)
+{
+        async_msg_2(icmp_phone, NET_ICMP_TIME_EXCEEDED, (ipcarg_t) code,
+            (ipcarg_t) packet_get_id(packet));
         return EOK;
 }
 
-int icmp_parameter_problem_msg(int icmp_phone, icmp_code_t code, icmp_param_t pointer, packet_t packet){
-        async_msg_3(icmp_phone, NET_ICMP_PARAMETERPROB, (ipcarg_t) code, (ipcarg_t) packet_get_id(packet), (ipcarg_t) pointer);
+/** Sends the Parameter Problem error notification packet.
+ *
+ * Beginning of the packet is sent as the notification packet data.
+ * The source and the destination addresses should be set in the original
+ * packet.
+ *
+ * @param[in] icmp_phone The ICMP module phone used for (semi)remote calls.
+ * @param[in] code      The error specific code.
+ * @param[in] pointer   The problematic parameter offset.
+ * @param[in] packet    The original packet.
+ * @returns             EOK on success.
+ * @returns             EPERM if the ICMP error notifications are disabled.
+ * @returns             ENOMEM if there is not enough memory left.
+ */
+int icmp_parameter_problem_msg(int icmp_phone, icmp_code_t code,
+    icmp_param_t pointer, packet_t packet)
+{
+        async_msg_3(icmp_phone, NET_ICMP_PARAMETERPROB, (ipcarg_t) code,
+            (ipcarg_t) packet_get_id(packet), (ipcarg_t) pointer);
         return EOK;
 }
@@ -69 +133 @@
 /** @}
  */
+