00001 /* /////////////////////////////////////////////////////////////////////////
00002  * File:        pantheios/backend.h
00003  *
00004  * Purpose:     Pantheios back end API
00005  *
00006  * Created:     21st June 2005
00007  * Updated:     3rd August 2008
00008  *
00009  * Author:      Matthew Wilson
00010  *
00011  * Home:        http://www.pantheios.org/
00012  *
00013  * Copyright:   Matthew Wilson and Synesis Software Pty Ltd, 1999-2005.
00014  *              Matthew Wilson, 2005-2008.
00015  *
00016  * Redistribution and use in source and binary forms, with or without
00017  * modification, are permitted provided that the following conditions are
00018  * met:
00019  *
00020  * - Redistributions of source code must retain the above copyright notice,
00021  *   this list of conditions and the following disclaimer.
00022  * - Redistributions in binary form must reproduce the above copyright
00023  *   notice, this list of conditions and the following disclaimer in the
00024  *   documentation and/or other materials provided with the distribution.
00025  * - Neither the name(s) of Matthew Wilson and Synesis Software nor the
00026  *   names of any contributors may be used to endorse or promote products
00027  *   derived from this software without specific prior written permission.
00028  *
00029  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
00030  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
00031  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00032  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
00033  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00034  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00035  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00036  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00037  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00038  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00039  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00040  *
00041  * ////////////////////////////////////////////////////////////////////// */
00042 
00043 
00049 #ifndef PANTHEIOS_INCL_PANTHEIOS_H_BACKEND
00050 #define PANTHEIOS_INCL_PANTHEIOS_H_BACKEND
00051 
00052 /* /////////////////////////////////////////////////////////////////////////
00053  * Version information
00054  */
00055 
00056 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00057 # define PANTHEIOS_VER_PANTHEIOS_H_BACKEND_MAJOR      3
00058 # define PANTHEIOS_VER_PANTHEIOS_H_BACKEND_MINOR      10
00059 # define PANTHEIOS_VER_PANTHEIOS_H_BACKEND_REVISION   1
00060 # define PANTHEIOS_VER_PANTHEIOS_H_BACKEND_EDIT       25
00061 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
00062 
00063 /* /////////////////////////////////////////////////////////////////////////
00064  * Includes
00065  */
00066 
00067 #ifndef PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS
00068 # include <pantheios/pantheios.h>
00069 #endif /* !PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS */
00070 
00071 /* /////////////////////////////////////////////////////////////////////////
00072  * Back-end API
00073  */
00074 
00118 #define PANTHEIOS_BEID_ALL                      (0)
00119 
00127 #define PANTHEIOS_BEID_LOCAL                    (1)
00128 
00137 #define PANTHEIOS_BEID_REMOTE                   (2)
00138 
00139 /* /////////////////////////////////////////////////////////////////////////
00140  * Constants
00141  */
00142 
00219 #define PANTHEIOS_BE_INIT_F_NO_PROCESS_ID       (0x00000001)
00220 #define PANTHEIOS_BE_INIT_F_NO_THREAD_ID        (0x00001000)
00221 #define PANTHEIOS_BE_INIT_F_NO_DATETIME         (0x00000002)
00222 #define PANTHEIOS_BE_INIT_F_NO_SEVERITY         (0x00000004)
00223 #define PANTHEIOS_BE_INIT_F_USE_SYSTEM_TIME     (0x00000008)
00224 #define PANTHEIOS_BE_INIT_F_DETAILS_AT_START    (0x00000010)
00225 #define PANTHEIOS_BE_INIT_F_USE_UNIX_FORMAT     (0x00000020)
00226 #define PANTHEIOS_BE_INIT_F_HIDE_DATE           (0x00000040)
00227 #define PANTHEIOS_BE_INIT_F_HIDE_TIME           (0x00000080)
00228 #define PANTHEIOS_BE_INIT_F_HIGH_RESOLUTION     (0x00000100)
00229 #define PANTHEIOS_BE_INIT_F_LOW_RESOLUTION      (0x00000200)
00230 
00231 
00243 #define PANTHEIOS_BE_INIT_F_COMMON_MASK         (0x000fffff)
00244 #ifdef __cplusplus
00245 # define PANTHEIOS_BE_INIT_F_CUSTOM_MASK        (~static_cast<int>(PANTHEIOS_BE_INIT_F_COMMON_MASK))
00246 #else /* ? __cplusplus */
00247 # define PANTHEIOS_BE_INIT_F_CUSTOM_MASK        (~((int)PANTHEIOS_BE_INIT_F_COMMON_MASK))
00248 #endif /* __cplusplus */
00249 
00250 
00251 
00284 PANTHEIOS_CALL(int) pantheios_be_init(  char const* processIdentity
00285                                     ,   void*       reserved
00286                                     ,   void**      ptoken);
00287 
00302 PANTHEIOS_CALL(void) pantheios_be_uninit(void* token);
00303 
00328 PANTHEIOS_CALL(int) pantheios_be_logEntry(  void*       feToken
00329                                         ,   void*       beToken
00330                                         ,   int         severity
00331                                         ,   char const* entry
00332                                         ,   size_t      cchEntry);
00333 
00336 /* /////////////////////////////////////////////////////////////////////////
00337  * Generation Macros
00338  */
00339 
00358 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00359 # define PANTHEIOS_BE_DEFINE_BE_FUNCTIONS_(fullId)                                                                               \
00360                                                                                                                                 \
00361     PANTHEIOS_CALL(int) pantheios_be_init(char const* processIdentity, void* reserved, void** ptoken)                           \
00362     { return fullId##_init(processIdentity, PANTHEIOS_BEID_LOCAL, NULL, reserved, ptoken); }                                    \
00363     PANTHEIOS_CALL(void) pantheios_be_uninit(void* token)                                                                       \
00364     { fullId##_uninit(token); }                                                                                                 \
00365     PANTHEIOS_CALL(int) pantheios_be_logEntry(void* feToken, void* beToken, int severity, char const* entry, size_t cchEntry)   \
00366     { STLSOFT_SUPPRESS_UNUSED(feToken); return fullId##_logEntry(feToken, beToken, severity, entry, cchEntry); }
00367 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
00368 
00369 #define PANTHEIOS_BE_DEFINE_BE_FUNCTIONS(id)    PANTHEIOS_BE_DEFINE_BE_FUNCTIONS_(pantheios_be_##id)
00370 
00371 
00372 
00373 
00392 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00393 # define PANTHEIOS_BE_DEFINE_BEL_FUNCTIONS_(fullId)                                                                                  \
00394                                                                                                                                     \
00395     PANTHEIOS_CALL(int) pantheios_be_local_init(char const* processIdentity, void* reserved, void** ptoken)                         \
00396     { return fullId##_init(processIdentity, PANTHEIOS_BEID_LOCAL, NULL, reserved, ptoken); }                                        \
00397     PANTHEIOS_CALL(void) pantheios_be_local_uninit(void* token)                                                                     \
00398     { fullId##_uninit(token); }                                                                                                     \
00399     PANTHEIOS_CALL(int) pantheios_be_local_logEntry(void* feToken, void* beToken, int severity, char const* entry, size_t cchEntry) \
00400     { STLSOFT_SUPPRESS_UNUSED(feToken); return fullId##_logEntry(feToken, beToken, severity, entry, cchEntry); }
00401 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
00402 
00403 #define PANTHEIOS_BE_DEFINE_BEL_FUNCTIONS(id)   PANTHEIOS_BE_DEFINE_BEL_FUNCTIONS_(pantheios_be_##id)
00404 
00423 #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
00424 # define PANTHEIOS_BE_DEFINE_BER_FUNCTIONS_(fullId)                                                                                      \
00425                                                                                                                                         \
00426     PANTHEIOS_CALL(int) pantheios_be_remote_init(char const* processIdentity, void* reserved, void** ptoken)                            \
00427     { return fullId##_init(processIdentity, PANTHEIOS_BEID_REMOTE, NULL, reserved, ptoken); }                                           \
00428     PANTHEIOS_CALL(void) pantheios_be_remote_uninit(void* token)                                                                        \
00429     { fullId##_uninit(token); }                                                                                                         \
00430     PANTHEIOS_CALL(int) pantheios_be_remote_logEntry(void* feToken, void* beToken, int severity, char const* entry, size_t cchEntry)    \
00431     { STLSOFT_SUPPRESS_UNUSED(feToken); return fullId##_logEntry(feToken, beToken, severity, entry, cchEntry); }
00432 #endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
00433 
00434 #define PANTHEIOS_BE_DEFINE_BER_FUNCTIONS(id)   PANTHEIOS_BE_DEFINE_BER_FUNCTIONS_(pantheios_be_##id)
00435 
00436 /* ////////////////////////////////////////////////////////////////////// */
00437 
00438 #endif /* !PANTHEIOS_INCL_PANTHEIOS_H_BACKEND */
00439 
00440 /* ////////////////////////////////////////////////////////////////////// */

pantheios Library documentation � Matthew Wilson, 2006-2008