journal.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef  JOURNAL_INCLUDED
#define  JOURNAL_INCLUDED

#include <stdio.h>
#include <mld/libmld_exports.h>

#ifdef __cplusplus
    extern "C"{
#endif

MLD_API void JOURNAL_routine_start (
    const char*     name    
    );

MLD_API int JOURNAL_set_file_name (
    const char*  file_name    
    );

MLD_API int JOURNAL_set_file_name_from_error_log ( void );

MLD_API int JOURNAL_ask_file_name (
    char**  file_name    
    );

MLD_API FILE* JOURNAL_get_file_fp ( void );

MLD_API int JOURNAL_open_file (
    const char*  file_name    
    );

MLD_API int JOURNAL_print_statistics();

MLD_API int JOURNAL_reset_statistics();

MLD_API int JOURNAL_close_file (void);

MLD_API void JOURNAL_routine_call(void);

MLD_API void JOURNAL_routine_end(void);

MLD_API void JOURNAL_comment (
    const char*     comment
    );

MLD_API void JOURNAL_set_journaling (
    logical enable_journaling
    );

MLD_API logical JOURNAL_is_journaling (void);

MLD_API void JOURNAL_output_argument (
    const char* name    
    );

MLD_API void JOURNAL_return_value (
    int     status      
    );

MLD_API void JOURNAL_nyi_in (
    const void*     in      
    );

MLD_API void JOURNAL_nyi_array_in (
    int         length,     
    const void* in          
    );

MLD_API void JOURNAL_nyi_out (
    const char*     name,   
    const void*     out     
    );

MLD_API void JOURNAL_nyi_array_out (
    const char*     name,       
    int             length,     
    const void*     out         
    );

MLD_API void JOURNAL_integer_in (
    int     in      
    );

MLD_API void JOURNAL_double_in (
    double  in      
    );

MLD_API void JOURNAL_logical_in (
    logical in      
    );

MLD_API void JOURNAL_char_in (
    char    in      
    );

MLD_API void JOURNAL_string_in (
    const char*     in      
    );

MLD_API void JOURNAL_tag_in (
    tag_t   in      
    );

MLD_API void JOURNAL_date_in (
    date_t  in      
    );

MLD_API void JOURNAL_address_in (
    const void*     in      
    );

MLD_API void JOURNAL_integer_array_in (
    int         length,     
    const int*  array       
    );

MLD_API void JOURNAL_double_array_in (
    int             length,     
    const double*   array       
    );

MLD_API void JOURNAL_logical_array_in (
    int             length,     
    const logical*  array       
    );

MLD_API void JOURNAL_char_array_in (
    int         length,     
    const char* array       
    );

MLD_API void JOURNAL_string_array_in (
    int                  length,     
    const char * const * array       
    );

MLD_API void JOURNAL_tag_array_in (
    int             length,     
    const tag_t*    array       
    );

MLD_API void JOURNAL_date_array_in (
    int             length,     
    const date_t*   array       
    );

MLD_API void JOURNAL_integer_out (
    const char* name,   
    int         out     
    );

MLD_API void JOURNAL_double_out (
    const char* name,   
    double      out     
    );

MLD_API void JOURNAL_logical_out (
    const char* name,   
    logical     out     
    );

MLD_API void JOURNAL_char_out (
    const char* name,   
    char        out     
    );

MLD_API void JOURNAL_string_out (
    const char*     name,   
    const char*     out     
    );

MLD_API void JOURNAL_tag_out (
    const char* name,       
    tag_t       out         
    );

MLD_API void JOURNAL_date_out (
    const char* name,       
    date_t      out         
    );

MLD_API void JOURNAL_address_out (
    const char*     name,   
    const void*     in      
    );

MLD_API void JOURNAL_integer_array_out (
    const char* name,       
    int         length,     
    const int*  array       
    );

MLD_API void JOURNAL_double_array_out (
    const char*     name,       
    int             length,     
    const double*   array       
    );

MLD_API void JOURNAL_logical_array_out (
    const char*     name,       
    int             length,     
    const logical*  array       
    );

MLD_API void JOURNAL_char_array_out (
    const char* name,       
    int         length,     
    const char* array       
    );

MLD_API void JOURNAL_string_array_out (
    const char *         name,       
    int                  length,     
    const char * const * array       
    );

MLD_API void JOURNAL_tag_array_out (
    const char*     name,       
    int             length,     
    const tag_t*    array       
    );

MLD_API void JOURNAL_date_array_out (
    const char*     name,       
    int             length,     
    const date_t*   array       
    );

MLD_API void JOURNAL_flush (void);

MLD_API void JOURNAL_file_to_stream (
    int     nbytes,
    FILE*   stream
    );

MLD_API logical JOURNAL_set_dpat_on (
    logical  on_of_off    
    );

MLD_API void JOURNAL_zero_dpat_data (void);

MLD_API logical JOURNAL_dpat_on_or_off (void);

MLD_API void JOURNAL_dpat_report (
    FILE*   stream      
    );

MLD_API int JOURNAL_ask_call_depth (void);

MLD_API int JOURNAL_ask_sql_count ( void );

MLD_API void JOURNAL_decrement_sql_count(void);

MLD_API void JOURNAL_increment_sql_count(void);

MLD_API void JOURNAL_zero_sql_count(void);

MLD_API double JOURNAL_ask_sql_total_time (void);

MLD_API void JOURNAL_add_sql_total_time(double time_taken);

MLD_API void JOURNAL_zero_sql_total_time (void);

MLD_API logical JOURNAL_assert_call_depth (
    int    depth      
    );

MLD_API logical JOURNAL_get_routine_stats(
    const char* routine_name,
    double* cpu_time,
    double* real_time,
    int* trip_count,
    int* call_count
    );


MLD_API int JOURNAL_newpjl_get_method_id(const char* name);
MLD_API int JOURNAL_newpjl_enter(int id);
MLD_API void JOURNAL_newpjl_exit(int serial);
MLD_API void JOURNAL_newpjl_ip_request(const char* process, const char* requestName, const char* correlationId);
MLD_API void JOURNAL_newpjl_ip_response(int responseSize, int errCode, const char* correlationId);
MLD_API void JOURNAL_newpjl_start_correlation_id(const char* correlationId);
MLD_API void JOURNAL_newpjl_end_correlation_id(const char* correlationId);
MLD_API void JOURNAL_newpjl_record_stat(const char* name, const double value);
MLD_API void JOURNAL_newpjl_comment(const char* comment);
MLD_API int JOURNAL_newpjl_routine_start(int id);

#ifdef __cplusplus
}
#endif
#include <mld/libmld_undef.h>

#endif