-
Notifications
You must be signed in to change notification settings - Fork 589
/
Copy pathicmp_ping.h
114 lines (95 loc) · 4.35 KB
/
icmp_ping.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/****************************************************************************
* apps/include/netutils/icmp_ping.h
*
* SPDX-License-Identifier: Apache-2.0
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __APPS_INCLUDE_NETUTILS_ICMP_PING_H
#define __APPS_INCLUDE_NETUTILS_ICMP_PING_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <netinet/in.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Positive number represent information */
#define ICMP_I_OK 0 /* extra: not used */
#define ICMP_I_BEGIN 1 /* extra: not used */
#define ICMP_I_ROUNDTRIP 2 /* extra: packet delay */
#define ICMP_I_FINISH 3 /* extra: elapsed time */
/* Negative odd number represent error(unrecoverable) */
#define ICMP_E_HOSTIP -1 /* extra: not used */
#define ICMP_E_MEMORY -3 /* extra: not used */
#define ICMP_E_SOCKET -5 /* extra: error code */
#define ICMP_E_SENDTO -7 /* extra: error code */
#define ICMP_E_SENDSMALL -9 /* extra: sent bytes */
#define ICMP_E_POLL -11 /* extra: error code */
#define ICMP_E_RECVFROM -13 /* extra: error code */
#define ICMP_E_RECVSMALL -15 /* extra: recv bytes */
/* Negative even number represent warning(recoverable) */
#define ICMP_W_TIMEOUT -2 /* extra: timeout value */
#define ICMP_W_IDDIFF -4 /* extra: recv id */
#define ICMP_W_SEQNOBIG -6 /* extra: recv seqno */
#define ICMP_W_SEQNOSMALL -8 /* extra: recv seqno */
#define ICMP_W_RECVBIG -10 /* extra: recv bytes */
#define ICMP_W_DATADIFF -12 /* extra: not used */
#define ICMP_W_TYPE -14 /* extra: recv type */
/****************************************************************************
* Public Types
****************************************************************************/
struct ping_result_s;
struct ping_info_s
{
FAR const char *hostname; /* Host name to ping */
uint16_t count; /* Number of pings requested */
uint16_t datalen; /* Number of bytes to be sent */
uint16_t delay; /* Deciseconds to delay between pings */
uint16_t timeout; /* Deciseconds to wait response before timeout */
FAR void *priv; /* Private context for callback */
void (*callback)(FAR const struct ping_result_s *result);
};
struct ping_result_s
{
int code; /* Notice code ICMP_I/E/W_XXX */
long extra; /* Extra information for code */
struct in_addr dest; /* Target address to ping */
uint16_t nrequests; /* Number of ICMP ECHO requests sent */
uint16_t nreplies; /* Number of matching ICMP ECHO replies received */
uint16_t outsize; /* Bytes(include ICMP header) to be sent */
uint16_t id; /* ICMP_ECHO id */
uint16_t seqno; /* ICMP_ECHO seqno */
FAR const struct ping_info_s *info;
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
void icmp_ping(FAR const struct ping_info_s *info);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __APPS_INCLUDE_NETUTILS_ICMP_PING_H */