demo/SimpleHello/EPTF_Applib_SimpleHello/src/Logger/EPTF_SimpleHello_Logger_Definitions.ttcn

///////////////////////////////////////////////////////////////////////////////
//                                                                           //
// Copyright (c) 2000-2017 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_SimpleHello_Logger_Definitions
//
// Purpose:
//   This module contains the definitions used by the EPTF_SimpleHello_Logger_CT
//   component.
//
// Module Parameters:
//     tsp_EPTF_SimpleHello_Logging_Decode - *boolean* - can be used for setting that the decoded or the RAW message will be logged
//							 default value:*true*
//
// Module depends on:
//   <EPTF_SimpleHello_Definitions>
// 
// Current Owner:
//    Attila Fulop (EFLOATT), Bence Molnar(EBENMOL)
// 
// Last Review Date:
//    2009-04-03
//
// Detailed Comments:
//    -
///////////////////////////////////////////////////////////
module EPTF_SimpleHello_Logger_Definitions {

//=========================================================================
// Import Part
//=========================================================================

import from EPTF_SimpleHello_Definitions all;

//=========================================================================
// Module parameters
//=========================================================================

modulepar
{
  boolean tsp_EPTF_SimpleHello_Logging_Decode := true;
}

//=========================================================================
// Data Types
//=========================================================================

///////////////////////////////////////////////////////////
// Type: EPTF_SimpleHello_LoggerMessage
//
// Purpose:
//   type to send on EPTF_SimpleHello_Logger_PT 
//
// Elements:
//   octetMessage - *octetstring* - the octetstring message
//   isRequest - *boolean* - the request/response indicator
///////////////////////////////////////////////////////////  
type record EPTF_SimpleHello_LoggerMessage
{
  octetstring octetMessage,
  boolean isRequest
} 

///////////////////////////////////////////////////////////
// Type: f_EPTF_SimpleHello_LoggerClient_FT
//
// Purpose:
//   Function type to register LoggerClient send function 
//
// Elements:
//   pl_message - *in* - *octetstring* - the outgoing octetstring message
///////////////////////////////////////////////////////////  
type function f_EPTF_SimpleHello_LoggerClient_FT (
  in EPTF_SimpleHello_LoggerMessage pl_message) 
runs on self;

///////////////////////////////////////////////////////////
// Type: EPTF_SimpleHello_LoggerClient_CT 
//
// Purpose:
//   The type definition of the LoggerClient component 
//
// Extensions:
//   -
//
// Variables:
//   vf_EPTF_SimpleHello_LoggerClient_sendFunction - <f_EPTF_SimpleHello_LoggerClient_FT> - Function to reference the logging send function
//   vc_EPTF_SimpleHello_LoggerClient_loggerComponent - <EPTF_SimpleHello_Logger_CT> - The Logger component
//   v_EPTF_SimpleHello_LoggerClient_initialized - *boolean* - The component initialized variable
//
//  Timers:
//    -
//
//  Ports:
//   SimpleHello_LoggerClient_PCO - <EPTF_SimpleHello_Logger_PT> - Communiucation port between the LoggerClient and The Logger components
//
// Detailed Comments:
//   -
//
///////////////////////////////////////////////////////////
type component EPTF_SimpleHello_LoggerClient_CT 
{
  port EPTF_SimpleHello_Logger_PT 			SimpleHello_LoggerClient_PCO;
  var f_EPTF_SimpleHello_LoggerClient_FT 		vf_EPTF_SimpleHello_LoggerClient_sendFunction := null;
  var EPTF_SimpleHello_Logger_CT 			vc_EPTF_SimpleHello_LoggerClient_loggerComponent;
  var boolean 					        v_EPTF_SimpleHello_LoggerClient_initialized := false; 
}

///////////////////////////////////////////////////////////
// Type: EPTF_SimpleHello_Logger_PT
//
// Purpose:
//   SimpleHello Logger port type
//
//  Parameters:
//    - *inout* - <EPTF_SimpleHello_LoggerMessage> - Logger message 
//
// Detailed Comments:
//   The port receives a SimpleHello message as octetstring
//
///////////////////////////////////////////////////////////
type port EPTF_SimpleHello_Logger_PT message {
  inout EPTF_SimpleHello_LoggerMessage;
} with { extension "internal" };

///////////////////////////////////////////////////////////
// Type: EPTF_SimpleHello_Logger_CT 
//
// Purpose:
//   SimpleHello Logger component type 
//
// Extensions:
//   -
//
// Variables:
//   v_EPTF_SimpleHello_Logger_Msg - <EPTF_SimpleHello_LoggerMessage> - Logger message
//
//  Timers:
//    -
//
//  Ports:
//   SimpleHello_LoggerClient_PCO - <EPTF_SimpleHello_Logger_PT> - Communiucation port between the LoggerClient and The Logger components
//
// Detailed Comments:
//   -
//
///////////////////////////////////////////////////////////
type component EPTF_SimpleHello_Logger_CT {
  port EPTF_SimpleHello_Logger_PT SimpleHello_Logger_PCO;
  var EPTF_SimpleHello_LoggerMessage v_EPTF_SimpleHello_Logger_Msg;
}

} // end of module