You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

119 lines
4.6 KiB

/* /////////////////////////////////////////////////////////////////////////
* File: pantheios/backends/bec.ACE.h
*
* Purpose: Declaration of the Pantheios ACE Stock Back-end API.
*
* Created: 21st June 2005
* Updated: 11th September 2009
*
* Home: http://www.pantheios.org/
*
* Copyright (c) 2005-2009, Matthew Wilson and Synesis Software
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - Neither the name(s) of Matthew Wilson and Synesis Software nor the
* names of any contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* ////////////////////////////////////////////////////////////////////// */
/** \file pantheios/backends/bec.ACE.h
*
* [C, C++] Pantheios ACE Back-end Common API
*/
#ifndef PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_ACE_SRC
#define PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_ACE_SRC
/* /////////////////////////////////////////////////////////////////////////
* Version information
*/
#ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
# define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_ACE_MAJOR 1
# define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_ACE_MINOR 1
# define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_ACE_REVISION 1
# define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_ACE_EDIT 12
#endif /* !PANTHEIOS_DOCUMENTATION_SKIP_SECTION */
/* /////////////////////////////////////////////////////////////////////////
* Includes
*/
#ifndef PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS
# include <pantheios/pantheios.h>
#endif /* !PANTHEIOS_INCL_PANTHEIOS_H_PANTHEIOS */
#ifndef PANTHEIOS_INCL_PANTHEIOS_H_BACKEND
# include <pantheios/backend.h>
#endif /* !PANTHEIOS_INCL_PANTHEIOS_H_BACKEND */
/* /////////////////////////////////////////////////////////////////////////
* Documentation
*/
/** \defgroup group__backend__stock_backends__ACE Pantheios ACE Stock Back-end
* \ingroup group__backend__stock_backends
* Back-end library built on top of the diagnostic logging facilities of
* the <a href = "http://www.cs.wustl.edu/~schmidt/ACE.html">Adaptive Communications Environment (ACE)</a>.
*/
/* /////////////////////////////////////////////////////////////////////////
* API
*/
/** Implements the functionality for pantheios_be_init() over the ACE Diagnostic Logging API.
* \ingroup group__backend__stock_backends__ACE
*/
PANTHEIOS_CALL(int) pantheios_be_ACE_init(
PAN_CHAR_T const* processIdentity
, int id
, void* unused
, void* reserved
, void** ptoken
);
/** Implements the functionality for pantheios_be_uninit() over the ACE Diagnostic Logging API.
* \ingroup group__backend__stock_backends__ACE
*/
PANTHEIOS_CALL(void) pantheios_be_ACE_uninit(
void* token
);
/** Implements the functionality for pantheios_be_logEntry() over the ACE Diagnostic Logging API.
* \ingroup group__backend__stock_backends__ACE
*/
PANTHEIOS_CALL(int) pantheios_be_ACE_logEntry(
void* feToken
, void* beToken
, int severity
, PAN_CHAR_T const* entry
, size_t cchEntry
);
/* ////////////////////////////////////////////////////////////////////// */
#endif /* PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_ACE_SRC */
/* ///////////////////////////// end of file //////////////////////////// */