1 | /*
|
---|
2 | * Copyright (c) 2009 Lukas Mejdrech
|
---|
3 | * All rights reserved.
|
---|
4 | *
|
---|
5 | * Redistribution and use in source and binary forms, with or without
|
---|
6 | * modification, are permitted provided that the following conditions
|
---|
7 | * are met:
|
---|
8 | *
|
---|
9 | * - Redistributions of source code must retain the above copyright
|
---|
10 | * notice, this list of conditions and the following disclaimer.
|
---|
11 | * - Redistributions in binary form must reproduce the above copyright
|
---|
12 | * notice, this list of conditions and the following disclaimer in the
|
---|
13 | * documentation and/or other materials provided with the distribution.
|
---|
14 | * - The name of the author may not be used to endorse or promote products
|
---|
15 | * derived from this software without specific prior written permission.
|
---|
16 | *
|
---|
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
---|
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
---|
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
---|
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
---|
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
---|
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
---|
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
---|
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
---|
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
---|
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
---|
27 | */
|
---|
28 |
|
---|
29 | /** @addtogroup icmp
|
---|
30 | * @{
|
---|
31 | */
|
---|
32 |
|
---|
33 | /** @file
|
---|
34 | * ICMP module common interface.
|
---|
35 | */
|
---|
36 |
|
---|
37 | #ifndef __NET_ICMP_COMMON_H__
|
---|
38 | #define __NET_ICMP_COMMON_H__
|
---|
39 |
|
---|
40 | #include <ipc/services.h>
|
---|
41 |
|
---|
42 | #include <sys/time.h>
|
---|
43 |
|
---|
44 | /** Default timeout for incoming connections in microseconds.
|
---|
45 | */
|
---|
46 | #define ICMP_CONNECT_TIMEOUT ( 1 * 1000 * 1000 )
|
---|
47 |
|
---|
48 | /** Connects to the ICMP module.
|
---|
49 | * @param service The ICMP module service. Ignored parameter.
|
---|
50 | * @param[in] timeout The connection timeout in microseconds. No timeout if set to zero (0).
|
---|
51 | * @returns The ICMP module phone on success.
|
---|
52 | * @returns The ICMP socket identifier if called by the bundle module.
|
---|
53 | * @returns ETIMEOUT if the connection timeouted.
|
---|
54 | */
|
---|
55 | int icmp_connect_module( services_t service, suseconds_t timeout );
|
---|
56 |
|
---|
57 | #endif
|
---|
58 |
|
---|
59 | /** @}
|
---|
60 | */
|
---|