errno.h

Go to the documentation of this file.

/* $Id: errno.h 4359 2013-02-21 11:18:36Z bennylp $ */
/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJ_ERRNO_H__
#define __PJ_ERRNO_H__

#include <pj/types.h>
#include <pj/compat/errno.h>
#include <stdarg.h>

PJ_BEGIN_DECL

#define PJ_ERR_MSG_SIZE  80

#ifndef PJ_PERROR_TITLE_BUF_SIZE
#   define PJ_PERROR_TITLE_BUF_SIZE     120
#endif


PJ_DECL(pj_status_t) pj_get_os_error(void);

PJ_DECL(void) pj_set_os_error(pj_status_t code);

PJ_DECL(pj_status_t) pj_get_netos_error(void);

PJ_DECL(void) pj_set_netos_error(pj_status_t code);


PJ_DECL(pj_str_t) pj_strerror( pj_status_t statcode, 
                               char *buf, pj_size_t bufsize);

#define PJ_PERROR(level,arg)    do { \
                                    pj_perror_wrapper_##level(arg); \
                                } while (0)

PJ_DECL(void) pj_perror(int log_level, const char *sender, pj_status_t status,
                        const char *title_fmt, ...);


typedef pj_str_t (*pj_error_callback)(pj_status_t e, char *msg, pj_size_t max);


PJ_DECL(pj_status_t) pj_register_strerror(pj_status_t start_code,
                                          pj_status_t err_space,
                                          pj_error_callback f);

#ifndef PJ_RETURN_OS_ERROR
#   define PJ_RETURN_OS_ERROR(os_code)   (os_code ? \
                                            PJ_STATUS_FROM_OS(os_code) : -1)
#endif


#if PJ_NATIVE_ERR_POSITIVE
#   define PJ_STATUS_FROM_OS(e) (e == 0 ? PJ_SUCCESS : e + PJ_ERRNO_START_SYS)
#else
#   define PJ_STATUS_FROM_OS(e) (e == 0 ? PJ_SUCCESS : PJ_ERRNO_START_SYS - e)
#endif

#if PJ_NATIVE_ERR_POSITIVE
#   define PJ_STATUS_TO_OS(e) (e == 0 ? PJ_SUCCESS : e - PJ_ERRNO_START_SYS)
#else
#   define PJ_STATUS_TO_OS(e) (e == 0 ? PJ_SUCCESS : PJ_ERRNO_START_SYS - e)
#endif


#ifndef PJ_BUILD_ERR
#   define PJ_BUILD_ERR(code,msg) { code, msg " (" #code ")" }
#endif


#define PJ_EUNKNOWN         (PJ_ERRNO_START_STATUS + 1) /* 70001 */

#define PJ_EPENDING         (PJ_ERRNO_START_STATUS + 2) /* 70002 */

#define PJ_ETOOMANYCONN     (PJ_ERRNO_START_STATUS + 3) /* 70003 */

#define PJ_EINVAL           (PJ_ERRNO_START_STATUS + 4) /* 70004 */

#define PJ_ENAMETOOLONG     (PJ_ERRNO_START_STATUS + 5) /* 70005 */

#define PJ_ENOTFOUND        (PJ_ERRNO_START_STATUS + 6) /* 70006 */

#define PJ_ENOMEM           (PJ_ERRNO_START_STATUS + 7) /* 70007 */

#define PJ_EBUG             (PJ_ERRNO_START_STATUS + 8) /* 70008 */

#define PJ_ETIMEDOUT        (PJ_ERRNO_START_STATUS + 9) /* 70009 */

#define PJ_ETOOMANY         (PJ_ERRNO_START_STATUS + 10)/* 70010 */

#define PJ_EBUSY            (PJ_ERRNO_START_STATUS + 11)/* 70011 */

#define PJ_ENOTSUP          (PJ_ERRNO_START_STATUS + 12)/* 70012 */

#define PJ_EINVALIDOP       (PJ_ERRNO_START_STATUS + 13)/* 70013 */

#define PJ_ECANCELLED       (PJ_ERRNO_START_STATUS + 14)/* 70014 */

#define PJ_EEXISTS          (PJ_ERRNO_START_STATUS + 15)/* 70015 */

#define PJ_EEOF             (PJ_ERRNO_START_STATUS + 16)/* 70016 */

#define PJ_ETOOBIG          (PJ_ERRNO_START_STATUS + 17)/* 70017 */

#define PJ_ERESOLVE         (PJ_ERRNO_START_STATUS + 18)/* 70018 */

#define PJ_ETOOSMALL        (PJ_ERRNO_START_STATUS + 19)/* 70019 */

#define PJ_EIGNORED         (PJ_ERRNO_START_STATUS + 20)/* 70020 */

#define PJ_EIPV6NOTSUP      (PJ_ERRNO_START_STATUS + 21)/* 70021 */

#define PJ_EAFNOTSUP        (PJ_ERRNO_START_STATUS + 22)/* 70022 */

#define PJ_EGONE            (PJ_ERRNO_START_STATUS + 23)/* 70023 */
   /* pj_errnum */
   /* pj_errno */


#define PJ_ERRNO_START          20000

#define PJ_ERRNO_SPACE_SIZE     50000

#define PJ_ERRNO_START_STATUS   (PJ_ERRNO_START + PJ_ERRNO_SPACE_SIZE)

#define PJ_ERRNO_START_SYS      (PJ_ERRNO_START_STATUS + PJ_ERRNO_SPACE_SIZE)

#define PJ_ERRNO_START_USER     (PJ_ERRNO_START_SYS + PJ_ERRNO_SPACE_SIZE)


/*
 * Below are list of error spaces that have been taken so far:
 *  - PJSIP_ERRNO_START         (PJ_ERRNO_START_USER)
 *  - PJMEDIA_ERRNO_START       (PJ_ERRNO_START_USER + PJ_ERRNO_SPACE_SIZE)
 *  - PJSIP_SIMPLE_ERRNO_START  (PJ_ERRNO_START_USER + PJ_ERRNO_SPACE_SIZE*2)
 *  - PJLIB_UTIL_ERRNO_START    (PJ_ERRNO_START_USER + PJ_ERRNO_SPACE_SIZE*3)
 *  - PJNATH_ERRNO_START        (PJ_ERRNO_START_USER + PJ_ERRNO_SPACE_SIZE*4)
 *  - PJMEDIA_AUDIODEV_ERRNO_START (PJ_ERRNO_START_USER + PJ_ERRNO_SPACE_SIZE*5)
 *  - PJ_SSL_ERRNO_START           (PJ_ERRNO_START_USER + PJ_ERRNO_SPACE_SIZE*6)
 *  - PJMEDIA_VIDEODEV_ERRNO_START (PJ_ERRNO_START_USER + PJ_ERRNO_SPACE_SIZE*7)
 */

/* Internal */
void pj_errno_clear_handlers(void);


/****** Internal for PJ_PERROR *******/

#if PJ_LOG_MAX_LEVEL >= 1
    #define pj_perror_wrapper_1(arg)    pj_perror_1 arg

    PJ_DECL(void) pj_perror_1(const char *sender, pj_status_t status, 
                              const char *title_fmt, ...);
#else
    #define pj_perror_wrapper_1(arg)
#endif

#if PJ_LOG_MAX_LEVEL >= 2
    #define pj_perror_wrapper_2(arg)    pj_perror_2 arg

    PJ_DECL(void) pj_perror_2(const char *sender, pj_status_t status, 
                              const char *title_fmt, ...);
#else
    #define pj_perror_wrapper_2(arg)
#endif

#if PJ_LOG_MAX_LEVEL >= 3
    #define pj_perror_wrapper_3(arg)    pj_perror_3 arg

    PJ_DECL(void) pj_perror_3(const char *sender, pj_status_t status, 
                              const char *title_fmt, ...);
#else
    #define pj_perror_wrapper_3(arg)
#endif

#if PJ_LOG_MAX_LEVEL >= 4
    #define pj_perror_wrapper_4(arg)    pj_perror_4 arg

    PJ_DECL(void) pj_perror_4(const char *sender, pj_status_t status, 
                              const char *title_fmt, ...);
#else
    #define pj_perror_wrapper_4(arg)
#endif

#if PJ_LOG_MAX_LEVEL >= 5
    #define pj_perror_wrapper_5(arg)    pj_perror_5 arg

    PJ_DECL(void) pj_perror_5(const char *sender, pj_status_t status, 
                              const char *title_fmt, ...);
#else
    #define pj_perror_wrapper_5(arg)
#endif

#if PJ_LOG_MAX_LEVEL >= 6
    #define pj_perror_wrapper_6(arg)    pj_perror_6 arg

    PJ_DECL(void) pj_perror_6(const char *sender, pj_status_t status, 
                              const char *title_fmt, ...);
#else
    #define pj_perror_wrapper_6(arg)
#endif




PJ_END_DECL

#endif  /* __PJ_ERRNO_H__ */