Changeset 753bca3 in mainline for uspace/lib/c/include/ipc/icmp.h

Timestamp:

2010-10-13T22:38:16Z (14 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

10056483, b2a109d9

Parents:

f3b4051

Message:

Move ICMP client stuff from libsocket to standard library.

File:

• uspace/lib/c/include/ipc/icmp.h (moved) (moved from uspace/lib/socket/include/icmp_messages.h ) (1 diff)

uspace/lib/c/include/ipc/icmp.h

@@ -27 +27 @@
  */
 
-/** @addtogroup icmp
- *  @{
+/** @addtogroup libc
+ * @{
  */
 
 /** @file
- *  ICMP module messages.
- *  @see icmp_interface.h
+ * ICMP module messages.
+ * @see icmp_interface.h
  */
 
-#ifndef __NET_ICMP_MESSAGES__
-#define __NET_ICMP_MESSAGES__
+#ifndef LIBC_ICMP_MESSAGES_
+#define LIBC_ICMP_MESSAGES_
 
 #include <ipc/ipc.h>
 #include <ipc/net.h>
 #include <sys/types.h>
+#include <sys/time.h>
 
-#include <icmp_codes.h>
+#include <net/icmp_codes.h>
 
-/** ICMP module messages.
- */
-typedef enum{
-        /** Sends echo request.
-         *  @see icmp_echo()
-         */
+/** ICMP module messages. */
+typedef enum {
+        /** Sends echo request. @see icmp_echo() */
         NET_ICMP_ECHO = NET_ICMP_FIRST,
-        /** Sends destination unreachable error message.
-         *  @see icmp_destination_unreachable_msg()
+        
+        /**
+         * Sends destination unreachable error message.
+         * @see icmp_destination_unreachable_msg()
          */
         NET_ICMP_DEST_UNREACH,
-        /** Sends source quench error message.
-         *  @see icmp_source_quench_msg()
+        
+        /**
+         * Sends source quench error message.
+         * @see icmp_source_quench_msg()
          */
         NET_ICMP_SOURCE_QUENCH,
-        /** Sends time exceeded error message.
-         *  @see icmp_time_exceeded_msg()
+        
+        /**
+         * Sends time exceeded error message.
+         * @see icmp_time_exceeded_msg()
          */
         NET_ICMP_TIME_EXCEEDED,
-        /** Sends parameter problem error message.
-         *  @see icmp_parameter_problem_msg()
+        
+        /**
+         * Sends parameter problem error message.
+         * @see icmp_parameter_problem_msg()
          */
         NET_ICMP_PARAMETERPROB,
-        /** Initializes new connection.
-         */
+        
+        /** Initializes new connection. */
         NET_ICMP_INIT
 } icmp_messages;
 
-/** @name ICMP specific message parameters definitions
- */
+/** @name ICMP specific message parameters definitions */
 /*@{*/
 
 /** Returns the ICMP code message parameter.
- *  @param[in] call The message call structure.
+ *
+ * @param[in] call      The message call structure.
  */
 #define ICMP_GET_CODE(call) \
-        ({icmp_code_t code = (icmp_code_t) IPC_GET_ARG1(*call); code;})
+        ({ \
+                icmp_code_t code = (icmp_code_t) IPC_GET_ARG1(*call); \
+                code; \
+        })
 
 /** Returns the ICMP link MTU message parameter.
- *  @param[in] call The message call structure.
+ *
+ * @param[in] call      The message call structure.
  */
 #define ICMP_GET_MTU(call) \
-        ({icmp_param_t mtu = (icmp_param_t) IPC_GET_ARG3(*call); mtu;})
+        ({ \
+                icmp_param_t mtu = (icmp_param_t) IPC_GET_ARG3(*call); \
+                mtu; \
+        })
 
 /** Returns the pointer message parameter.
- *  @param[in] call The message call structure.
+ *
+ * @param[in] call      The message call structure.
  */
 #define ICMP_GET_POINTER(call) \
-        ({icmp_param_t pointer = (icmp_param_t) IPC_GET_ARG3(*call); pointer;})
+        ({ \
+                icmp_param_t pointer = (icmp_param_t) IPC_GET_ARG3(*call); \
+                pointer; \
+        })
 
 /** Returns the size message parameter.
- *  @param[in] call The message call structure.
+ *
+ * @param[in] call      The message call structure.
  */
 #define ICMP_GET_SIZE(call) \
-        ({size_t size = (size_t) IPC_GET_ARG1(call); size;})
+        ({ \
+                size_t size = (size_t) IPC_GET_ARG1(call); \
+                size; \
+        })
 
 /** Returns the timeout message parameter.
- *  @param[in] call The message call structure.
+ *
+ * @param[in] call      The message call structure.
  */
 #define ICMP_GET_TIMEOUT(call) \
-        (({suseconds_t timeout = (suseconds_t) IPC_GET_ARG2(call); timeout;}))
+        ({ \
+                suseconds_t timeout = (suseconds_t) IPC_GET_ARG2(call); \
+                timeout; \
+        })
 
 /** Returns the time to live message parameter.
- *  @param[in] call The message call structure.
+ *
+ * @param[in] call      The message call structure.
  */
 #define ICMP_GET_TTL(call) \
-        ({ip_ttl_t ttl = (ip_ttl_t) IPC_GET_ARG3(call); ttl;})
+        ({ \
+                ip_ttl_t ttl = (ip_ttl_t) IPC_GET_ARG3(call); \
+                ttl; \
+        })
 
 /** Returns the type of service message parameter.
- *  @param[in] call The message call structure.
+ *
+ * @param[in] call      The message call structure.
  */
 #define ICMP_GET_TOS(call) \
-        ({ip_tos_t tos = (ip_tos_t) IPC_GET_ARG4(call); tos;})
+        ({ \
+                ip_tos_t tos = (ip_tos_t) IPC_GET_ARG4(call); \
+                tos; \
+        })
 
 /** Returns the dont fragment message parameter.
- *  @param[in] call The message call structure.
+ *
+ * @param[in] call      The message call structure.
  */
 #define ICMP_GET_DONT_FRAGMENT(call) \
-        ({int dont_fragment = (int) IPC_GET_ARG5(call); dont_fragment;})
+        ({ \
+                int dont_fragment = (int) IPC_GET_ARG5(call); \
+                dont_fragment; \
+        })
 
 /*@}*/