git.meshlink.io Git - catta/blob - avahi-common/error.h

   1 #ifndef fooerrorhfoo
   2 #define fooerrorhfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of avahi.
   8
   9   avahi is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as
  11   published by the Free Software Foundation; either version 2.1 of the
  12   License, or (at your option) any later version.
  13
  14   avahi is distributed in the hope that it will be useful, but WITHOUT
  15   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  16   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  17   Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public
  20   License along with avahi; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 /** \file error.h Error codes and auxiliary functions */
  26
  27 #include <avahi-common/cdecl.h>
  28
  29 /** \mainpage
  30  *
  31  * \section Error Reporting
  32  *
  33  * Some notes on the Avahai erro handling:
  34  *
  35  * \li Error codes are negative integers and defined in the enum AVAHI_ERR_xx
  36  * \li If a function returns some kind of non-negative integer value on success, a failure is indicated by returning the error code directly.
  37  * \li If a function returns a pointer of some kind on success, a failure is indicated by returning NULL
  38  * \li The last error number may be retrieved by calling avahi_server_errno() (for the server API) or avahi_client_errno() (for the client API)
  39  * \li Just like the libc errno the Avahi errno is NOT reset to AVAHI_OK if a function call succeeds.
  40  * \li You may convert a numeric error code into a human readable string using avahi_strerror.c
  41  *
  42  */
  43
  44 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  45 AVAHI_C_DECL_BEGIN
  46 #endif
  47
  48 /** Error codes used by avahi */
  49 enum {
  50     AVAHI_OK = 0,                          /**< OK */
  51     AVAHI_ERR_FAILURE = -1,                /**< Generic error code */
  52     AVAHI_ERR_BAD_STATE = -2,              /**< Object was in a bad state */
  53     AVAHI_ERR_INVALID_HOST_NAME = -3,      /**< Invalid host name */
  54     AVAHI_ERR_INVALID_DOMAIN_NAME = -4,    /**< Invalid domain name */
  55     AVAHI_ERR_NO_NETWORK = -5,             /**< No suitable network protocol available */
  56     AVAHI_ERR_INVALID_TTL = -6,            /**< Invalid DNS TTL */
  57     AVAHI_ERR_IS_PATTERN = -7,             /**< RR key is pattern */
  58     AVAHI_ERR_LOCAL_COLLISION = -8,        /**< Local name collision */
  59     AVAHI_ERR_INVALID_RECORD = -9,         /**< Invalid RR */
  60     AVAHI_ERR_INVALID_SERVICE_NAME = -10,  /**< Invalid service name */
  61     AVAHI_ERR_INVALID_SERVICE_TYPE = -11,  /**< Invalid service type */
  62     AVAHI_ERR_INVALID_PORT = -12,          /**< Invalid port number */
  63     AVAHI_ERR_INVALID_KEY = -13,           /**< Invalid key */
  64     AVAHI_ERR_INVALID_ADDRESS = -14,       /**< Invalid address */
  65     AVAHI_ERR_TIMEOUT = -15,               /**< Timeout reached */
  66     AVAHI_ERR_TOO_MANY_CLIENTS = -16,      /**< Too many clients */
  67     AVAHI_ERR_TOO_MANY_OBJECTS = -17,      /**< Too many objects */
  68     AVAHI_ERR_TOO_MANY_ENTRIES = -18,      /**< Too many entries */
  69     AVAHI_ERR_OS = -19,                    /**< OS error */
  70     AVAHI_ERR_ACCESS_DENIED = -20,         /**< Access denied */
  71     AVAHI_ERR_INVALID_OPERATION = -21,     /**< Invalid operation */
  72     AVAHI_ERR_DBUS_ERROR = -22,            /**< An unexpected DBUS error occured */
  73     AVAHI_ERR_NOT_CONNECTED = -23,         /**< Could not get a connection to the daemon */
  74     AVAHI_ERR_NO_MEMORY = -24,             /**< Memory exhausted */
  75     AVAHI_ERR_INVALID_OBJECT = -25,        /**< The object passed to this function was invalid */
  76     AVAHI_ERR_NO_DAEMON = -26,             /**< Daemon not running */
  77
  78     /****
  79      ****    IF YOU ADD A NEW ERROR CODE HERE, PLEASE DON'T FORGET TO ADD
  80      ****    IT TO THE STRING ARRAY IN avahi_strerror() IN error.c AND
  81      ****    TO THE ARRAY IN dbus.c AND FINALLY TO dbus.h!
  82      ****
  83      ****    Also remember to update the MAX value below.
  84      ****/
  85
  86     AVAHI_ERR_MAX = -27
  87 };
  88
  89 /** Return a human readable error string for the specified error code */
  90 const char *avahi_strerror(int error);
  91
  92 #ifndef DOXYGEN_SHOULD_SKIP_THIS
  93 AVAHI_C_DECL_END
  94 #endif
  95
  96 #endif