1 r.kieninger 1.1 //%2006////////////////////////////////////////////////////////////////////////
 2                 //
 3                 // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
 4                 // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
 5                 // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
 6                 // IBM Corp.; EMC Corporation, The Open Group.
 7                 // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
 8                 // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
 9                 // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
10                 // EMC Corporation; VERITAS Software Corporation; The Open Group.
11                 // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
12                 // EMC Corporation; Symantec Corporation; The Open Group.
13                 //
14                 // Permission is hereby granted, free of charge, to any person obtaining a copy
15                 // of this software and associated documentation files (the "Software"), to
16                 // deal in the Software without restriction, including without limitation the
17                 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
18                 // sell copies of the Software, and to permit persons to whom the Software is
19                 // furnished to do so, subject to the following conditions:
20                 // 
21                 // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
22 r.kieninger 1.1 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
23                 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
24                 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
25                 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
26                 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
27                 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28                 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29                 //
30                 //==============================================================================
31                 //
32                 //%/////////////////////////////////////////////////////////////////////////////
33                 
34                 
35                 #ifndef Pegasus_TraceHandler_h
36                 #define Pegasus_TraceHandler_h
37                 
38                 #include <cstdarg>
39                 #include <cstdio>
40                 #include <Pegasus/Common/String.h>
41                 #include <Pegasus/Common/Linkage.h>
42                 
43 r.kieninger 1.1 PEGASUS_NAMESPACE_BEGIN
44                 
45                 /** TraceHandler is an abstract base class for all kinds of trace handlers.
46                  */
47                 
48                 class PEGASUS_COMMON_LINKAGE TraceHandler
49                 {
50                 public:
51                 
52                     /** Writes message with format string to the tracing facility
53                         @param    message  message to be written
54                         @param    fmt      printf style format string
55                         @param    argList  variable argument list
56                      */
57                     virtual void handleMessage(const char* message,
58                                                const char* fmt,
59                                                va_list argList) = 0;
60                 
61                     /** Writes simple message to the tracing facility.
62                         @param    message  message to be written
63                      */
64 r.kieninger 1.1     virtual void handleMessage(const char* message) = 0;
65                 
66                 
67                     /** Sets and prepares the destination (e.g. traceFileName) for the
68                         trace handler.
69                         @param    destination tracer destination, e.g. file
70                         @return   0           if the function is successful
71                                   1           if an error occurs
72                      */
73                     virtual Uint32 setMessageDestination(const char* destination) {return 0;};
74                 
75                     /** Validates the File Path for the trace File
76                         @param    filePath full path of the file
77                         @return   1        if the file path is valid
78                                   0        if the file path is invalid
79                      */
80                     virtual Boolean isValidMessageDestination(const char* destination) 
81                         {return true;};
82                     
83                     TraceHandler() {};
84                 
85 r.kieninger 1.1     virtual ~TraceHandler() {};
86                 
87                     
88                 };
89                 
90                 PEGASUS_NAMESPACE_END
91                 
92                 #endif /* Pegasus_TraceHandler_h */