/*
 * (c) Copyright, Real-Time Innovations, 2002-2023.
 * 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 log_legacy_h
#define log_legacy_h

#include "log_dll.h"

#ifdef __cplusplus
extern "C" {
#endif

/*============================================================================*/
/*
 * Legacy logging templates
 * DO NOT ADD NEW TEMPLATES IN THIS SECTION
 * TRY TO REMOVE THE USAGE OF THESE TEMPLATES AND REPLACE THE LOG CALLS THAT
 * USE THEM WHEN POSSIBLE
 * DELETE A TEMPLATE IF YOU REMOVE ITS LAST USAGE
 */
/*============================================================================*/

/*e \ingroup RTILogMessageClass
  \brief NULL object reference.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_NULL_OBJECT;
/*e \ingroup RTILogMessageClass
  \brief Failed to add record to a table. Specify name of record.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ADD_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Object has already been created. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ALREADY_CREATED_s;
/*e \ingroup RTILogMessageClass
  \brief Object has already been destroyed. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ALREADY_DESTROYED_s;
/*e \ingroup RTILogMessageClass
  \brief Object has already been initialized; no need to initialize it again.
  Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ALREADY_INITIALIZED_s;
/*e \ingroup RTILogMessageClass
  \brief Print arbitrary string.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ANY_s;
/*e \ingroup RTILogMessageClass
  \brief Print arbitrary string.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ANY_ss;
/*e \ingroup RTILogMessageClass
  \brief Print arbitrary string and integer.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ANY_sssd;
/*e \ingroup RTILogMessageClass
  \brief Print arbitrary failure message.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ANY_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Print arbitrary failure messages.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ANY_FAILURE_ss;
/*e \ingroup RTILogMessageClass
  \brief Failed to assert a record into a table. Specify name of record.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ASSERT_FAILURE_s;
/*e \ingroup RTILogMessageClass
 * \brief Failed to assert a record into a table.
 * Specify name of record, and additional string to print.
 */
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ASSERT_FAILURE_ss;
/*e \ingroup RTILogMessageClass
  @brief Assertion failure with expected and actual integer values
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_UNEQUAL_INT_sdd;
/*e \ingroup RTILogMessageClass
  @brief Assertion failure with expected and actual long long values
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_UNEQUAL_LONG_LONG_sdd;

/*e \ingroup RTILogMessageClass
  @brief Assertion failure with expected and actual string values
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_MATCH_STRING_sss;

/*e \ingroup RTILogMessageClass
  \brief Created an object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_CREATE_s;
/*e \ingroup RTILogMessageClass
  \brief Failed to create object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_CREATION_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Failed to create object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_CREATION_FAILURE_ss;
/*e \ingroup RTILogMessageClass
  \brief Failed to enable object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ENABLE_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Deleted an object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_DELETE_s;
/*e \ingroup RTILogMessageClass
  \brief Failed to destroy object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_DESTRUCTION_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Failed to disable object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_DISABLE_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Report finalization. Specify what was finalized.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_FINALIZE_s;
/*e \ingroup RTILogMessageClass
  \brief Failed to get existing record or object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_GET_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Failed to get existing object. Specify name of object and context.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_GET_FAILURE_ss;
/*e \ingroup RTILogMessageClass
  \brief Failed to set existing object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SET_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Failed to set existing object. Specify name of object and context.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SET_FAILURE_ss;
/*e \ingroup RTILogMessageClass
  \brief Failed to initialize an object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_INIT_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Insufficient buffer space. Specify available space, followed
  by requested space.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_INSUFFICIENT_SPACE_FAILURE_dd;
/*e \ingroup RTILogMessageClass
  \brief Insufficient buffer space. Specify available space, followed
  by requested space.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_INSUFFICIENT_SPACE_FAILURE_uu;
/*e \ingroup RTILogMessageClass
  \brief Invalid object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_INVALID_s;
/*e \ingroup RTILogMessageClass
  \brief Print warning message when non-NULL listener is used with STATUS_MASK_NONE.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_LISTENER_MASK_NONE_WARN;
/*e \ingroup RTILogMessageClass
  \brief Invalid Property. Specifies the name of property and provides a suggestion.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_UNEXPECTED_PROPERTY_ssss;
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_UNEXPECTED_PROPERTY_sssss;
/*e \ingroup RTILogMessageClass
  \brief Invalid Property. Specifies the prefix of the property
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_INCONSISTENT_PROPERTY_s;
/*e \ingroup RTILogMessageClass
  \brief Invariance violation.
*/
extern RTILogDllVariable
const struct RTILogMessage RTI_LOG_INVARIANCE_VIOLATION;

/*e \ingroup RTILogMessageClass
  \brief Failed to allocate memory. Specify number of bytes requested.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_MALLOC_FAILURE_d;

/*e \ingroup RTILogMessageClass
  \brief Failed to get max heap size.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_GETRLIMIT_FAILURE;

/*e \ingroup RTILogMessageClass
  \brief Failed by allocating size larger than heap.
  Specify requested size and heap size.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_EXCEED_HEAP_FAILURE_uu;

/*e \ingroup RTILogMessageClass
  \brief Failed to give mutex.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_MUTEX_GIVE_FAILURE;
/*e \ingroup RTILogMessageClass
  \brief Failed to take mutex.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_MUTEX_TAKE_FAILURE;
/*e \ingroup RTILogMessageClass
  \brief An OS call failed. Specify OS call and corresponding error number.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_OS_FAILURE_sXs;
/*e \ingroup RTILogMessageClass
  \brief Precondition check failed.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PRECONDITION_FAILURE;
/*e \ingroup RTILogMessageClass
 * \brief A particular precondition check failed, identified by a string
 *        argument.
 */
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PRECONDITION_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Log reference count. Specify name and actual count.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_REFERENCE_COUNT_sd;
/*e \ingroup RTILogMessageClass
  \brief Failed to remove record from table. Specify name of record.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_REMOVE_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Failed to give semaphore.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SEMAPHORE_GIVE_FAILURE;
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SEMAPHORE_GIVE_FAILURE_x;
/*e \ingroup RTILogMessageClass
  \brief Failed to take semaphore.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SEMAPHORE_TAKE_FAILURE;
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SEMAPHORE_TAKE_FAILURE_x;
/*e \ingroup RTILogMessageClass
  \brief Skipping an object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SKIP_s;
/*e \ingroup RTILogMessageClass
  \brief Sleeping for some time failed. Specify number of seconds (string).
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SLEEP_FAILURE_s;
/*e \ingroup RTILogMessageClass
  \brief Stopped an active object. Specify name of object.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_STOP_s;
/*e \ingroup RTILogMessageClass
  @brief Unrecoverable error; fix this!
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_FATAL_EXCEPTION;
/*e \ingroup RTILogMessageClass
  @brief ??
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_UNEXPECTED_EXCEPTION;
/*e \ingroup RTILogMessageClass
  @brief Unexpected value.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_UNEXPECTED_VALUE_sd;
/*e \ingroup RTILogMessageClass
  @brief Unexpected value.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_UNEXPECTED_VALUE_su;
/*e \ingroup RTILogMessageClass
  @brief System failure with errno.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SYSTEM_FAILURE_d;

/*e \ingroup RTILogMessageClass
  @brief Timestamp in raw hex format
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_TIMESTAMP_xX;

/*e \ingroup RTILogMessageClass
  @brief Bad string format
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_BAD_STRING_FORMAT_ss;

/*e \ingroup RTILogMessageClass
  @brief Component not found or included in Connext installation.

  @details
  We define a constant value over here for maintaining a consistent message for
  missing extensions in Connext Pro. While it does break the datatype mould of other
  definitions here, it helps in maintaining a standardized message with the
  new XXX_Logger_log() API infrastructure.
*/
#define RTI_LOG_COMPONENT_NOT_INSTALLED_ss "The current configuration of your RTI " \
"product does not include %s, or it is not properly enabled. See " \
"https://community.rti.com/documentation for information about using and " \
"enabling %s. To purchase it, please contact your RTI sales representative " \
"or sales@rti.com."

/*e \ingroup RTILogMessageClass
  @brief any parser reports missing argument
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PARSER_ARGUMENT_MISSING_s;

/*e \ingroup RTILogMessageClass
  @brief any parser's failure
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PARSER_FAILURE_s;

/*e \ingroup RTILogMessageClass
  @brief any parser's failure
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PARSER_FAILURE_ss;

/*e \ingroup RTILogMessageClass
  @brief any parser's range error
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PARSER_VALUE_OUT_OF_RANGE_s;

/*e \ingroup RTILogMessageClass
  @brief any parser's range error with hint
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PARSER_VALUE_OUT_OF_RANGE_ss;

/*e \ingroup RTILogMessageClass
  @brief any parser's numeric conversion error
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PARSER_NUMERIC_CONVERSION_FAILURE_s;

/*e \ingroup RTILogMessageClass
  @brief any parser's numeric conversion error with value
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PARSER_NUMERIC_CONVERSION_FAILURE_ss;

/*e \ingroup RTILogMessageClass
  @brief feature not supported, contact support.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_NOT_SUPPORTED_CONTACT_SUPPORT_s;

/*e \ingroup RTILogMessageClass
  @brief Length exceeds the maximum.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_TRUNCATED_STRING_sds;

/*e \ingroup RTILogMessageClass
  \brief Associate worker to the current thread.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ASSOCIATE_WORKER_FAILURE;

/*e \ingroup RTILogMessageClass
  \brief Associate worker to the current thread.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_ASSOCIATE_WORKER_FAILURE_s;

/*e \ingroup RTILogMessageClass
  \brief Timeout expired.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_TIMEOUT_EXPIRED_s;

/*e \ingroup RTILogMessageClass
  \brief Index array out of bounds.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_INDEX_ARRAY_OUT_OF_BOUNDS_sddd;

/*e \ingroup RTILogMessageClass
  \brief Sequence is not the owner.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SEQUENCE_NOT_OWNER;

/*e \ingroup RTILogMessageClass
  \brief Bad parameter.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_BAD_PARAMETER_s;

/*e \ingroup RTILogMessageClass
  \brief Reached a max limit. Print the name of the limit and the value of the
         limit.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_REACHED_MAX_sd;

/*e \ingroup RTILogMessageClass
  \brief Property not found.
*/
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_PROPERTY_NOT_FOUND_s;

/*e \ingroup RTILogMessageClass
 * \brief Something is not supported.
 */
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_UNSUPPORTED_s;

/*e \ingroup RTILogMessageClass
 * \brief An unsigned 64-bit value is out of range.
 */
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_OUT_OF_RANGE_slludd;

/*e
 * \ingroup RTILogMessageClass
 * \brief An opening operation on a file has failed.
 */
extern RTILogDllVariable const struct RTILogMessage
        RTI_LOG_OPEN_FILE_FAILURE_ss;

/*e
 * \ingroup RTILogMessageClass
 * \brief A log message has been truncated.
 */
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_OVER_SIZE_WARNING;

/*e
 * \ingroup RTILogMessageClass
 * \brief Special RTILogMessage used for logging Security Events when the
 * Security logging plugin is configured to use the \ndds built-in logging.
 * \attention YOU SHOULD NOT USE THIS LOG MESSAGE IN ANY OTHER CASE.
 */
extern RTILogDllVariable const struct RTILogMessage RTI_LOG_SECURITY_EVENT_s;

#ifdef __cplusplus
}
#endif

#endif /* log_legacy_h */