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
|
/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-errors.c Error reporting
*
* Copyright (C) 2002 Red Hat Inc.
*
* Licensed under the Academic Free License version 1.2
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#include "dbus-errors.h"
/**
* @defgroup DBusErrors Error reporting
* @ingroup DBus
* @brief Error reporting
*
* Types and functions related to reporting errors.
*
*
* In essence D-BUS error reporting works as follows:
*
* @code
* DBusResultCode result = DBUS_RESULT_SUCCESS;
* dbus_some_function (arg1, arg2, &result);
* if (result != DBUS_RESULT_SUCCESS)
* printf ("an error occurred\n");
* @endcode
*
* @{
*/
/**
* Set a result code at a result code location,
* if code_address is not #NULL.
*
* @param code_address place to store the result code.
* @param code the result code itself.
*/
void
dbus_set_result (DBusResultCode *code_address,
DBusResultCode code)
{
if (code_address)
*code_address = code;
}
/**
* Returns a string describing the given result code.
*
* @param code the result code to describe.
* @returns a constant string describing the code.
*/
const char*
dbus_result_to_string (DBusResultCode code)
{
/* This is a switch to the compiler will complain if we
* aren't handling some codes
*/
switch (code)
{
case DBUS_RESULT_SUCCESS:
return "Success";
case DBUS_RESULT_FAILED:
return "Unknown error";
case DBUS_RESULT_NO_MEMORY:
return "Not enough memory available";
case DBUS_RESULT_IO_ERROR:
return "Error reading or writing data";
case DBUS_RESULT_BAD_ADDRESS:
return "Could not parse address";
case DBUS_RESULT_NOT_SUPPORTED:
return "Feature not supported";
case DBUS_RESULT_LIMITS_EXCEEDED:
return "Resource limits exceeded";
case DBUS_RESULT_ACCESS_DENIED:
return "Permission denied";
case DBUS_RESULT_AUTH_FAILED:
return "Could not authenticate to server";
case DBUS_RESULT_NO_SERVER:
return "No server";
case DBUS_RESULT_TIMEOUT:
return "Connection timed out";
case DBUS_RESULT_NO_NETWORK:
return "Network unavailable";
case DBUS_RESULT_ADDRESS_IN_USE:
return "Address already in use";
case DBUS_RESULT_DISCONNECTED:
return "Disconnected.";
case DBUS_RESULT_INVALID_FIELDS:
return "Invalid fields.";
/* no default, it would break our compiler warnings */
}
return "Invalid error code";
}
/** @} */
|
