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.
120 lines
4.5 KiB
120 lines
4.5 KiB
/* /////////////////////////////////////////////////////////////////////////
|
|
* File: pantheios/backends/bec.fail.h
|
|
*
|
|
* Purpose: Declaration of the Pantheios Fail Stock Back-end API.
|
|
*
|
|
* Created: 9th January 2007
|
|
* Updated: 11th September 2009
|
|
*
|
|
* Home: http://www.pantheios.org/
|
|
*
|
|
* Copyright (c) 2007-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.fail.h
|
|
*
|
|
* [C, C++] Pantheios Fail Back-end Common API
|
|
*/
|
|
|
|
#ifndef PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_FAIL
|
|
#define PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_FAIL
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* Version information
|
|
*/
|
|
|
|
#ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
|
|
# define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_FAIL_MAJOR 1
|
|
# define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_FAIL_MINOR 1
|
|
# define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_FAIL_REVISION 1
|
|
# define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_FAIL_EDIT 11
|
|
#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__fail Pantheios Fail Stock Back-end
|
|
* \ingroup group__backend__stock_backends
|
|
* Stub back-end library that fails its initialisation.
|
|
*
|
|
* This library is useful for testing \ref group__backend__stock_backends__N.
|
|
*/
|
|
|
|
/* /////////////////////////////////////////////////////////////////////////
|
|
* API
|
|
*/
|
|
|
|
/** Implements the functionality for pantheios_be_init() over the Fail API.
|
|
* \ingroup group__backend__stock_backends__fail
|
|
*/
|
|
PANTHEIOS_CALL(int) pantheios_be_fail_init(
|
|
PAN_CHAR_T const* processIdentity
|
|
, int id
|
|
, void* unused
|
|
, void* reserved
|
|
, void** ptoken
|
|
);
|
|
|
|
/** Implements the functionality for pantheios_be_uninit() over the Fail API.
|
|
* \ingroup group__backend__stock_backends__fail
|
|
*/
|
|
PANTHEIOS_CALL(void) pantheios_be_fail_uninit(
|
|
void* token
|
|
);
|
|
|
|
/** Implements the functionality for pantheios_be_logEntry() over the Fail API.
|
|
* \ingroup group__backend__stock_backends__fail
|
|
*/
|
|
PANTHEIOS_CALL(int) pantheios_be_fail_logEntry(
|
|
void* feToken
|
|
, void* beToken
|
|
, int severity
|
|
, PAN_CHAR_T const* entry
|
|
, size_t cchEntry
|
|
);
|
|
|
|
/* ////////////////////////////////////////////////////////////////////// */
|
|
|
|
#endif /* PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_FAIL */
|
|
|
|
/* ///////////////////////////// end of file //////////////////////////// */
|