blob: 6a71632da488747604edcea1172a5af0d44b534f (
plain)
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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
#if !defined(_LOG4CXX_ROLLING_TRIGGER_POLICY_H)
#define _LOG4CXX_ROLLING_TRIGGER_POLICY_H
#include <log4cxx/spi/optionhandler.h>
#include <log4cxx/helpers/objectimpl.h>
#include <log4cxx/spi/loggingevent.h>
#include <log4cxx/appender.h>
namespace log4cxx {
class File;
namespace rolling {
/**
* A <code>TriggeringPolicy</code> controls the conditions under which rollover
* occurs. Such conditions include time of day, file size, an
* external event or a combination thereof.
*
*
*
* */
class LOG4CXX_EXPORT TriggeringPolicy :
public virtual spi::OptionHandler,
public virtual helpers::ObjectImpl {
DECLARE_ABSTRACT_LOG4CXX_OBJECT(TriggeringPolicy)
BEGIN_LOG4CXX_CAST_MAP()
LOG4CXX_CAST_ENTRY(TriggeringPolicy)
LOG4CXX_CAST_ENTRY(spi::OptionHandler)
END_LOG4CXX_CAST_MAP()
public:
virtual ~TriggeringPolicy();
void addRef() const;
void releaseRef() const;
/**
* Determines if a rollover may be appropriate at this time. If
* true is returned, RolloverPolicy.rollover will be called but it
* can determine that a rollover is not warranted.
*
* @param appender A reference to the appender.
* @param event A reference to the currently event.
* @param filename The filename for the currently active log file.
* @param fileLength Length of the file in bytes.
* @return true if a rollover should occur.
*/
virtual bool isTriggeringEvent(
Appender* appender,
const log4cxx::spi::LoggingEventPtr& event,
const LogString& filename,
size_t fileLength) = 0;
};
LOG4CXX_PTR_DEF(TriggeringPolicy);
}
}
#endif
|
