/*
 * Copyright (c) 2009-2024 Real-Time Innovations, Inc. All rights reserved.
 * No duplications, whole or partial, manual or electronic, may be made
 * without express written permission.  Any such copies, or revisions thereof,
 * must display this notice unaltered.
 * This code contains trade secrets of Real-Time Innovations, Inc.
 */

#ifndef rtitls_log_h
#define rtitls_log_h

  #ifndef log_common_h
    #include "log/log_common.h"
  #endif
  #ifndef rtitls_dll_h
    #include "rtitls/rtitls_dll.h"
  #endif

#ifdef __cplusplus
extern "C" {
#endif

/* ================================================================= */
/*                         Main Documentation                        */
/* ================================================================= */

/* ----------------------------------------------------------------- */
/*                     Component Hierarchy                           */

/*i \defgroup RTITLSLogComponent RTITLSLog
  \ingroup RTITLSComponent

  @brief Logging facilities for rtitls module
*/

/* ================================================================= */
/*                         Component: Logging                        */
/* ================================================================= */
/*i \file
    \ingroup RTITLSLogComponent

    \brief Logging component interface and definitions.  Also defines
    the organization and layout of the online API documentation.
*/

/* ================================================================= */
/*                         Log Messages                              */
/* ================================================================= */

/*i \defgroup RTITLSLogMessageClass RTITLSLogMessage
  \ingroup RTITLSLogComponent
  \brief  Standard log message format strings with matching log message number. 
  Use these message format strings to provide a common look and feel for
  transport log messages.
  
  Example usage:
  \code
  
  ...
  
  RTITLSLog_exception(&RTITLS_LOG_FAILED_TO_INIT_s,
			      "incompatible properties");
  \endcode
  
  @see RTILogMessageClass
*/

/*i \ingroup RTITLSLogMessageClass
  \brief RTITLS OpenSSL identifier. For use in log message numbers.
  @see RTILogNumberBitmapClass
 */
  #define SUBMODULE_RTITLS_OPENSSL          (0x0000)

/*i \ingroup RTITLSLogMessageClass
  \brief RTITLS Connection identifier. For use in log message numbers.
  @see RTILogNumberBitmapClass
 */
  #define SUBMODULE_RTITLS_CONNECTION       (0x0001)

/* ================================================================= */
/*                         Log Verbosity                             */
/* ================================================================= */

/*i \ingroup RTITLSLogVerbosityClass
  \brief RTITLS openssl submodule identifier. Used for
  enabling log messages in the RTITLS OpenSSL submodule.
  @see \c RTITLS_Log_setBitmaps
 */
  #define RTITLS_SUBMODULE_MASK_OPENSSL (0x0001)

/*i \ingroup RTITLSLogVerbosityClass
  \brief RTITLS connection submodule identifier. Used for
  enabling log messages in the RTITLS connection submodule.
  @see \c RTITLS_Log_setBitmaps
 */
  #define RTITLS_SUBMODULE_MASK_CONNECTION (0x0002)

/*i \ingroup RTITLSLogVerbosityClass
  \brief Convenient way to say "enable logging for all RTITLS submodules".
  @see \c RTITLS_Log_setBitmaps
*/
  #define RTITLS_SUBMODULE_MASK_ALL RTI_LOG_SUBMODULE_MASK_ALL

/*i \ingroup RTITLSLogMessageClass
  \brief Verification failed. Specify peer name.
 */
extern RTITLSDllVariable const struct RTILogMessage RTITLS_LOG_OPENSSL_VERIFICATION_FAILURE_dds;
extern RTITLSDllVariable const struct RTILogMessage RTITLS_LOG_OPENSSL_VERIFICATION_SUCCESS;
extern RTITLSDllVariable const struct RTILogMessage RTITLS_LOG_OPENSSL_VERIFICATION_CERTINFO_ss;

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* rtitls_log_h */