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
|
/*
* libexplain - Explain errno values returned by libc functions
* Copyright (C) 2008, 2009, 2013 Peter Miller
* Written by Peter Miller <pmiller@opensource.org.au>
*
* 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_BUFFER_SOCKET_TYPE_H
#define LIBEXPLAIN_BUFFER_SOCKET_TYPE_H
struct explain_string_buffer_t; /* forward */
/**
* The explain_buffer_socket_type function may be used to print a
* symbolic representation of a socket type.
*
* @param sb
* The string buffer to print into.
* @param type
* The socket type to decipher.
*/
void explain_buffer_socket_type(struct explain_string_buffer_t *sb,
int type);
/**
* The explain_buffer_socket_type_from_fildes function may be used
* to supplement an error explanation with the type of a socet, taken
* from the file descriptor. Nothing is printed if thr socket type
* cannot be determined.
*
* @param sb
* The string buffer to print into.
* @param fildes
* the file descriptor to extract the socket type from and then print it
*/
void explain_buffer_socket_type_from_fildes(
struct explain_string_buffer_t *sb, int fildes);
/**
* The explain_parse_socket_type_or_die function may be used to
* parse a string into a socket type value. On error, prints a
* diagnostic and exits EXIT_FAILURE.
*
* @param text
* The string to parse.
* @param caption
* addition text to add to start of error message
* @returns
* the socket type
*/
int explain_parse_socket_type_or_die(const char *text, const char *caption);
#endif /* LIBEXPLAIN_BUFFER_SOCKET_TYPE_H */
/* vim: set ts=8 sw=4 et : */
|
