src/Transport/EPTF_CLL_Transport_IPsecHandler_Logging_Definitions.ttcn

///////////////////////////////////////////////////////////////////////////////
//                                                                           //
// Copyright (c) 2000-2019 Ericsson Telecom AB                               //
//                                                                           //
// All rights reserved. This program and the accompanying materials          //
// are made available under the terms of the Eclipse Public License v2.0     //
// which accompanies this distribution, and is available at                  //
// https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.html                                 //
//                                                                           //
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////////////////////////
//  Module: EPTF_CLL_Transport_IPsecHandler_Logging_Definitions
//
//  Purpose:
//    This module contains the implementation of IMS Logging feature definitions.
//
//  Module Parameters:
//    -
//
//  Module depends on:
//    <EPTF_CLL_Logging_Definitions>
//    <EPTF_CLL_Common_Definitions>
//
//  Detailed Comments:
//    If tsp_EPTF_CLL_Transport_IPsecHandler_Logging_showAsAction is set to true then the user debug info will be logged with TTCN_ACTION and also with TTCN_USER masks.
//      This way the developer and user debug information can be separated in the consol.
//
//    If tsp_LogEntryForLogCheck contains at least one string titansim will check the logs for that during execution. If it founds it
//    tsp_LogEntryForLogCheckMaxOccurence times it stop titansim. This is useful for debugging purposes when the logfile sizes would
//    become too large.
//
///////////////////////////////////////////////////////////////////////////////
module EPTF_CLL_Transport_IPsecHandler_Logging_Definitions {
  import from EPTF_CLL_Logging_Definitions all;

  group Types {
    ///////////////////////////////////////////////////////////
    //  Type: EPTF_CLL_Transport_IPsecHandler_Logging_CT
    //
    //  Purpose:
    //    Component is responsible for different kinds of logging.
    //
    //  Elements:
    //    v_EPTF_CLL_Transport_IPsecHandler_Logging_initialized - *boolean* - Flag to indicate that the component is initialized.
    //    v_EPTF_CLL_Transport_IPsecHandler_Logging_maskIdx - *integer* - The index of the register masks.
    //    v_EPTF_CLL_Transport_IPsecHandler_Logging_maskName - *charstring* - The name of the register masks.
    //    v_IMS_unacceptedLogs - *EPTF_CharstringList* - default: {} - Strings to check in log messages
    //    v_unnacceptedLogsRemaining - *integer* - default: 1 - How many occurences allowed any of the tsp_LogEntryForLogCheck strings
    //     - <> -
    //
    //  Detailed Comments:
    //    -
    //
    ///////////////////////////////////////////////////////////
    type component EPTF_CLL_Transport_IPsecHandler_Logging_CT extends EPTF_Logging_CT {
      private var boolean v_EPTF_CLL_Transport_IPsecHandler_Logging_initialized := false;
      private var integer v_EPTF_CLL_Transport_IPsecHandler_Logging_maskIdx := -1;
      private var charstring v_EPTF_CLL_Transport_IPsecHandler_Logging_maskName := "EPTF_CLL_Transport_IPsecHandler_Logging_CT";
    }
  }

  group Constants
  {
    ///////////////////////////////////////////////////////////
    //  Constant: cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingEventClasses
    //
    //  Purpose:
    //    List of logging event class names.
    //
    //  Elements:
    //    <EPTF_Logging_EventClassPrefixList> - List of event classes.
    //
    //  Detailed Comments:
    //    -
    //
    ///////////////////////////////////////////////////////////
    const EPTF_Logging_EventClassPrefixList cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingEventClasses := { "Warning", "Debug", "DebugUser", "DebugDev" };

    ///////////////////////////////////////////////////////////
    //  Constant: cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingClassIdx_*
    //
    //  Purpose:
    //    List of logging event class indexes.
    //
    //  Elements:
    //    cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingClassIdx_warning - *integer* - 0
    //    cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingClassIdx_debug - *integer* - 1
    //    cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingClassIdx_debugUser - *integer* - 2
    //    cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingClassIdx_debugDev - *integer* - 3
    //
    //  Detailed Comments:
    //    -
    //
    ///////////////////////////////////////////////////////////
    const integer cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingClassIdx_warning := 0;
    const integer cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingClassIdx_debug := 1;
    const integer cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingClassIdx_debugUser := 2;
    const integer cg_EPTF_CLL_Transport_IPsecHandler_Logging_loggingClassIdx_debugDev := 3;
  }
}