File: lcmaps_log.h

package info (click to toggle)
lcmaps 1.6.6-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 4,016 kB
  • ctags: 1,428
  • sloc: sh: 11,191; ansic: 9,519; makefile: 530; lex: 184; perl: 92; yacc: 60
file content (158 lines) | stat: -rw-r--r-- 5,926 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/**
 * Copyright (c) Members of the EGEE Collaboration. 2004-2010. 
 * See http://www.eu-egee.org/partners/ for details on the copyright
 * holders.  
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License. 
 * You may obtain a copy of the License at 
 * 
 *     http://www.apache.org/licenses/LICENSE-2.0 
 * 
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, 
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 * See the License for the specific language governing permissions and 
 * limitations under the License.
 *
 *
 *  Authors:
 *  2009-
 *     Oscar Koeroo <okoeroo@nikhef.nl>
 *     Mischa Sall\'e <msalle@nikhef.nl>
 *     David Groep <davidg@nikhef.nl>
 *     NIKHEF Amsterdam, the Netherlands
 *     <grid-mw-security@nikhef.nl> 
 *
 *  2007-2009
 *     Oscar Koeroo <okoeroo@nikhef.nl>
 *     David Groep <davidg@nikhef.nl>
 *     NIKHEF Amsterdam, the Netherlands
 *
 *  2003-2007
 *     Martijn Steenbakkers <martijn@nikhef.nl>
 *     Gerben Venekamp <venekamp@nikhef.nl>
 *     Oscar Koeroo <okoeroo@nikhef.nl>
 *     David Groep <davidg@nikhef.nl>
 *     NIKHEF Amsterdam, the Netherlands
 *
 */


/*!
    \file   lcmaps_log.h
    \brief  Logging API for the LCMAPS plugins and LCMAPS itself
    \author Martijn Steenbakkers for the EU DataGrid.

    This header contains the declarations of the LCMAPS logging functions
    The LCMAPS plugins can use this API to write output to the LCMAPS logging
    devices.
    -# lcmaps_log(): Log to LCMAPS logging devices.
    -# lcmaps_log_debug(): Produce debugging output.
    \ingroup APIforLcmapsPlugins
*/

#ifndef LCMAPS_LOG_H
#define LCMAPS_LOG_H

/******************************************************************************
                             Include header files
******************************************************************************/
#include <syslog.h>

/******************************************************************************
 *                            Module definition
 *****************************************************************************/
/******************************************************************************
Function:       lcmaps_log()
Description:    Log information to file and or syslog
Parameters:
                prty:    syslog priority (if 0 don't syslog)
                fmt:     string format
Returns:        0 succes
                1 failure
******************************************************************************/
#ifdef __GNUC__
extern int lcmaps_log(int prty, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
#else
extern int lcmaps_log(int prty, const char *fmt, ...);
#endif

/******************************************************************************
Function:       lcmaps_log_debug()
Description:    Print debugging information
Parameters:
                debug_lvl: debugging level
                fmt:       string format
Returns:        0 succes
                1 failure
******************************************************************************/
#ifdef __GNUC__
extern int lcmaps_log_debug(int debug_lvl, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
#else
extern int lcmaps_log_debug(int debug_lvl, const char *fmt, ...);
#endif

/******************************************************************************
Function:       lcmaps_log_time()
Description:    Log information to file and or syslog with a timestamp
Parameters:
                prty:    syslog priority (if 0 don't syslog)
                fmt:     string format
Returns:        0 succes
                1 failure
******************************************************************************/
#ifdef __GNUC__
extern int lcmaps_log_time(int prty, const char *fmt, ...)
    __attribute__((format(printf, 2, 3)));
#else
extern int lcmaps_log_time(int prty, const char *fmt, ...);
#endif

/******************************************************************************
Function:       lcmaps_log_a_string()
Description:    Log a string according to the passed format to file and or syslog
Parameters:
                prty:       syslog priority (if 0 don't syslog)
                fmt:        string format
                the_string: the string
Returns:        0 succes
                1 failure
******************************************************************************/
#ifdef __GNUC__
extern int lcmaps_log_a_string(int prty, const char *fmt, const char *the_string)
    __attribute__((deprecated))
    __attribute__((format(printf,2,0)));
#else
extern int lcmaps_log_a_string(int prty, const char *fmt, const char *the_string);
#endif

/******************************************************************************
Function:       lcmaps_log_a_string_debug()
Description:    Print debugging information
Parameters:
                debug_lvl:  debugging level
                fmt:        string format
                the_string: the string
Returns:        0 succes
                1 failure
******************************************************************************/
#ifdef __GNUC__
extern int lcmaps_log_a_string_debug(int debug_lvl, const char *fmt, const char *the_string)
    __attribute__((deprecated))
    __attribute__((format(printf,2,0)));
#else
extern int lcmaps_log_a_string_debug(int debug_lvl, const char *fmt, const char *the_string);
#endif

#endif /* LCMAPS_LOG_H */

/******************************************************************************
CVS Information:
    $Source: /srv/home/dennisvd/svn/mw-security/lcmaps/interface/lcmaps_log.h,v $
    $Date: 2014-07-07 17:24:01 +0200 (Mon, 07 Jul 2014) $
    $Revision: 17831 $
    $Author: msalle $
******************************************************************************/