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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
/*
* libexplain - Explain errno values returned by libc functions
* Copyright (C) 2008, 2009, 2013 Peter Miller
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 3 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBEXPLAIN_CONNECT_H
#define LIBEXPLAIN_CONNECT_H
/**
* @file
* @brief explain connect(2) errors
*/
#include <libexplain/gcc_attributes.h>
#ifdef __cplusplus
extern "C" {
#endif
struct sockaddr; /* forward */
/**
* The explain_connect_or_die function is used to call the
* <i>connect</i>(2) system call. On failure an explanation will be
* printed to stderr, obtained from the explain_connect(3) function, and
* then the process terminates by calling exit(EXIT_FAILURE).
*
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* explain_connect_or_die(fildes, serv_addr, serv_addr_size);
* @endcode
*
* @param fildes
* The fildes, exactly as to be passed to the <i>connect</i>(2) system
* call.
* @param serv_addr
* The serv_addr, exactly as to be passed to the <i>connect</i>(2)
* system call.
* @param serv_addr_size
* The serv_addr_size, exactly as to be passed to the
* <i>connect</i>(2) system call.
* @returns
* This function only returns on success. On failure, prints an
* explanation and exits, it does not return.
*/
void explain_connect_or_die(int fildes, const struct sockaddr *serv_addr,
int serv_addr_size);
/**
* The explain_connect_on_error function is used to call the
* <i>connect</i>(2) system call. On failure an explanation will be
* printed to stderr, obtained from the explain_connect(3) function.
*
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* if (explain_connect_on_error(fildes, serv_addr, serv_addr_size) < 0)
* {
* ...cope with error
* ...no need to print error message
* }
* @endcode
*
* @param fildes
* The fildes, exactly as to be passed to the <i>connect</i>(2) system
* call.
* @param serv_addr
* The serv_addr, exactly as to be passed to the <i>connect</i>(2)
* system call.
* @param serv_addr_size
* The serv_addr_size, exactly as to be passed to the
* <i>connect</i>(2) system call.
* @returns
* The value returned by the wrapped <i>connect</i>(2) system call.
*/
int explain_connect_on_error(int fildes, const struct sockaddr *serv_addr,
int serv_addr_size)
LIBEXPLAIN_WARN_UNUSED_RESULT;
/**
* The explain_connect function is used to obtain an explanation of an
* error returned by the <i>connect</i>(2) system call. The least the
* message will contain is the value of <tt>strerror(errno)</tt>, but
* usually it will do much better, and indicate the underlying cause in
* more detail.
*
* The errno global variable will be used to obtain the error value to be
* decoded.
*
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* if (connect(fildes, serv_addr, serv_addr_size) < 0)
* {
* fprintf(stderr, "%s\n", explain_connect(fildes, serv_addr,
* serv_addr_size));
* exit(EXIT_FAILURE);
* }
* @endcode
*
* The above code example is available pre-packaged as the
* #explain_connect_or_die function.
*
* @param fildes
* The original fildes, exactly as passed to the <i>connect</i>(2)
* system call.
* @param serv_addr
* The original serv_addr, exactly as passed to the <i>connect</i>(2)
* system call.
* @param serv_addr_size
* The original serv_addr_size, exactly as passed to the
* <i>connect</i>(2) system call.
* @returns
* The message explaining the error. This message buffer is shared by
* all libexplain functions which do not supply a buffer in their
* argument list. This will be overwritten by the next call to any
* libexplain function which shares this buffer, including other
* threads.
* @note
* This function is <b>not</b> thread safe, because it shares a return
* buffer across all threads, and many other functions in this
* library.
*/
const char *explain_connect(int fildes, const struct sockaddr *serv_addr,
int serv_addr_size)
LIBEXPLAIN_WARN_UNUSED_RESULT;
/**
* The explain_errno_connect function is used to obtain an explanation of
* an error returned by the <i>connect</i>(2) system call. The least the
* message will contain is the value of <tt>strerror(errnum)</tt>, but
* usually it will do much better, and indicate the underlying cause in
* more detail.
*
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* if (connect(fildes, serv_addr, serv_addr_size) < 0)
* {
* int err = errno;
* fprintf(stderr, "%s\n", explain_connect(err, fildes, serv_addr,
* serv_addr_size));
* exit(EXIT_FAILURE);
* }
* @endcode
*
* The above code example is available pre-packaged as the
* #explain_connect_or_die function.
*
* @param errnum
* The error value to be decoded, usually obtained from the errno
* global variable just before this function is called. This is
* necessary if you need to call <b>any</b> code between the system
* call to be explained and this function, because many libc functions
* will alter the value of errno.
* @param fildes
* The original fildes, exactly as passed to the <i>connect</i>(2)
* system call.
* @param serv_addr
* The original serv_addr, exactly as passed to the <i>connect</i>(2)
* system call.
* @param serv_addr_size
* The original serv_addr_size, exactly as passed to the
* <i>connect</i>(2) system call.
* @returns
* The message explaining the error. This message buffer is shared by
* all libexplain functions which do not supply a buffer in their
* argument list. This will be overwritten by the next call to any
* libexplain function which shares this buffer, including other
* threads.
* @note
* This function is <b>not</b> thread safe, because it shares a return
* buffer across all threads, and many other functions in this
* library.
*/
const char *explain_errno_connect(int errnum, int fildes,
const struct sockaddr *serv_addr, int serv_addr_size)
LIBEXPLAIN_WARN_UNUSED_RESULT;
/**
* The explain_message_connect function is used to obtain an explanation
* of an error returned by the <i>connect</i>(2) system call. The least
* the message will contain is the value of <tt>strerror(errnum)</tt>, but
* usually it will do much better, and indicate the underlying cause in
* more detail.
*
* The errno global variable will be used to obtain the error value to be
* decoded.
*
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* if (connect(fildes, serv_addr, serv_addr_size) < 0)
* {
* char message[3000];
* explain_message_connect(message, sizeof(message), fildes, serv_addr,
* serv_addr_size);
* fprintf(stderr, "%s\n", message);
* exit(EXIT_FAILURE);
* }
* @endcode
*
* The above code example is available pre-packaged as the
* #explain_connect_or_die function.
*
* @param message
* The location in which to store the returned message. If a suitable
* message return buffer is supplied, this function is thread safe.
* @param message_size
* The size in bytes of the location in which to store the returned
* message.
* @param fildes
* The original fildes, exactly as passed to the <i>connect</i>(2)
* system call.
* @param serv_addr
* The original serv_addr, exactly as passed to the <i>connect</i>(2)
* system call.
* @param serv_addr_size
* The original serv_addr_size, exactly as passed to the
* <i>connect</i>(2) system call.
*/
void explain_message_connect(char *message, int message_size, int fildes,
const struct sockaddr *serv_addr, int serv_addr_size);
/**
* The explain_message_errno_connect function is used to obtain an
* explanation of an error returned by the <i>connect</i>(2) system call.
* The least the message will contain is the value of
* <tt>strerror(errnum)</tt>, but usually it will do much better, and
* indicate the underlying cause in more detail.
*
* This function is intended to be used in a fashion similar to the
* following example:
* @code
* if (connect(fildes, serv_addr, serv_addr_size) < 0)
* {
* int err = errno;
* char message[3000];
* explain_message_errno_connect(message, sizeof(message), err, fildes,
* serv_addr, serv_addr_size);
* fprintf(stderr, "%s\n", message);
* exit(EXIT_FAILURE);
* }
* @endcode
*
* The above code example is available pre-packaged as the
* #explain_connect_or_die function.
*
* @param message
* The location in which to store the returned message. If a suitable
* message return buffer is supplied, this function is thread safe.
* @param message_size
* The size in bytes of the location in which to store the returned
* message.
* @param errnum
* The error value to be decoded, usually obtained from the errno
* global variable just before this function is called. This is
* necessary if you need to call <b>any</b> code between the system
* call to be explained and this function, because many libc functions
* will alter the value of errno.
* @param fildes
* The original fildes, exactly as passed to the <i>connect</i>(2)
* system call.
* @param serv_addr
* The original serv_addr, exactly as passed to the <i>connect</i>(2)
* system call.
* @param serv_addr_size
* The original serv_addr_size, exactly as passed to the
* <i>connect</i>(2) system call.
*/
void explain_message_errno_connect(char *message, int message_size, int errnum,
int fildes, const struct sockaddr *serv_addr, int serv_addr_size);
#ifdef __cplusplus
}
#endif
/* vim: set ts=8 sw=4 et : */
#endif /* LIBEXPLAIN_CONNECT_H */
|
