aboutsummaryrefslogtreecommitdiffstats
path: root/src/SocketError.hxx
blob: 53a0c1d8fd5d1d10ceb940ac697e9bff97ce7484 (plain) (blame)
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
/*
 * Copyright (C) 2003-2013 The Music Player Daemon Project
 * http://www.musicpd.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef MPD_SOCKET_ERROR_HXX
#define MPD_SOCKET_ERROR_HXX

#include "gcc.h"

#include <glib.h>

#ifdef WIN32
#include <winsock2.h>
typedef DWORD socket_error_t;
#else
#include <errno.h>
typedef int socket_error_t;
#endif

/**
 * A GQuark for GError for socket I/O errors.  The code is an errno
 * value (or WSAGetLastError() on Windows).
 */
gcc_const
static inline GQuark
SocketErrorQuark(void)
{
	return g_quark_from_static_string("socket");
}

gcc_pure
static inline socket_error_t
GetSocketError()
{
#ifdef WIN32
	return WSAGetLastError();
#else
	return errno;
#endif
}

gcc_const
static inline bool
IsSocketErrorAgain(socket_error_t code)
{
#ifdef WIN32
	return code == WSAEINPROGRESS;
#else
	return code == EAGAIN;
#endif
}

gcc_const
static inline bool
IsSocketErrorInterruped(socket_error_t code)
{
#ifdef WIN32
	return code == WSAEINTR;
#else
	return code == EINTR;
#endif
}

gcc_const
static inline bool
IsSocketErrorClosed(socket_error_t code)
{
#ifdef WIN32
	return code == WSAECONNRESET;
#else
	return code == EPIPE || code == ECONNRESET;
#endif
}

/**
 * Helper class that formats a socket error message into a
 * human-readable string.  On Windows, a buffer is necessary for this,
 * and this class hosts the buffer.
 */
class SocketErrorMessage {
#ifdef WIN32
	char msg[256];
#else
	const char *const msg;
#endif

public:
#ifdef WIN32
	explicit SocketErrorMessage(socket_error_t code=GetSocketError()) {
		DWORD nbytes = FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM |
					     FORMAT_MESSAGE_IGNORE_INSERTS |
					     FORMAT_MESSAGE_MAX_WIDTH_MASK,
					     NULL, code, 0,
					     (LPSTR)msg, sizeof(msg), NULL);
		if (nbytes == 0)
			strcpy(msg, "Unknown error");
	}
#else
	explicit SocketErrorMessage(socket_error_t code=GetSocketError())
		:msg(g_strerror(code)) {}
#endif

	operator const char *() const {
		return msg;
	}
};

static inline void
SetSocketError(GError **error_r, socket_error_t code)
{
#ifdef WIN32
	if (error_r == NULL)
		return;
#endif

	const SocketErrorMessage msg(code);
	g_set_error_literal(error_r, SocketErrorQuark(), code, msg);
}

static inline void
SetSocketError(GError **error_r)
{
	SetSocketError(error_r, GetSocketError());
}

gcc_malloc
static inline GError *
NewSocketError(socket_error_t code)
{
	const SocketErrorMessage msg(code);
	return g_error_new_literal(SocketErrorQuark(), code, msg);
}

gcc_malloc
static inline GError *
NewSocketError()
{
	return NewSocketError(GetSocketError());
}

#endif