text: /* /////////////////////////////////////////////////////////////////////////
   * File:        pantheios/backends/bec.null.h
   *
   * Purpose:     Declaration of the Pantheios NULL Stock Back-end API.
   *
   * Created:     10th July 2006
   * Updated:     29th June 2016
   *
   * Home:        http://www.pantheios.org/
   *
   * Copyright (c) 2006-2016, 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.null.h
   *
   * [C, C++] Pantheios NULL Back-end Common API
   */
  
  #ifndef PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_BEC_NULL_SRC
  #define PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_BEC_NULL_SRC
  
  /* /////////////////////////////////////////////////////////////////////////
   * version information
   */
  
  #ifndef PANTHEIOS_DOCUMENTATION_SKIP_SECTION
  # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_NULL_MAJOR      1
  # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_NULL_MINOR      2
  # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_NULL_REVISION   1
  # define PANTHEIOS_VER_PANTHEIOS_BACKENDS_H_BEC_NULL_EDIT       13
  #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__null Pantheios NULL Stock Back-end
   * \ingroup group__backend__stock_backends
   *  Stub back-end library that does no emission.
   *
   * This library is useful for conducting performance tests.
   */
  
  /* /////////////////////////////////////////////////////////////////////////
   * API
   */
  
  /** Implements the functionality for pantheios_be_init() over the NULL API.
   * \ingroup group__backend__stock_backends__null
   */
  PANTHEIOS_CALL(int) pantheios_be_null_init(
      PAN_CHAR_T const*   processIdentity
  ,   int                 id
  ,   void*               unused
  ,   void*               reserved
  ,   void**              ptoken
  );
  
  /** Implements the functionality for pantheios_be_uninit() over the NULL API.
   * \ingroup group__backend__stock_backends__null
   */
  PANTHEIOS_CALL(void) pantheios_be_null_uninit(
      void* token
  );
  
  /** Implements the functionality for pantheios_be_logEntry() over the NULL API.
   * \ingroup group__backend__stock_backends__null
   */
  PANTHEIOS_CALL(int) pantheios_be_null_logEntry(
      void*               feToken
  ,   void*               beToken
  ,   int                 severity
  ,   PAN_CHAR_T const*   entry
  ,   size_t              cchEntry
  );
  
  /** \def pantheios_be_null_parseArgs
   *
   * Parses the be.null back-end flags
   *
   * \ingroup group__backend
   *
   * There are currently no arguments whatsoever for be.null, hence
   * pantheios_be_null_parseArgs is actually a \#define for
   * <code>NULL</code>. At such time as back-end specific arguments
   * are required, it will become a first-class function.
   */
  #define pantheios_be_null_parseArgs         NULL
  
  /* ////////////////////////////////////////////////////////////////////// */
  
  #endif /* PANTHEIOS_INCL_PANTHEIOS_BACKENDS_H_BEC_NULL_SRC */
  
  /* ///////////////////////////// end of file //////////////////////////// */
  