summaryrefslogtreecommitdiff
path: root/indra/llcommon/llliveappconfig.h
blob: 73b3a2335272cd695d2ff9f0d4b108e6faff7d56 (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
/** 
 * @file llliveappconfig.h
 * @brief Configuration information for an LLApp that overrides indra.xml
 *
 * $LicenseInfo:firstyear=2003&license=viewergpl$
 * 
 * Copyright (c) 2003-2009, Linden Research, Inc.
 * 
 * Second Life Viewer Source Code
 * The source code in this file ("Source Code") is provided by Linden Lab
 * to you under the terms of the GNU General Public License, version 2.0
 * ("GPL"), unless you have obtained a separate licensing agreement
 * ("Other License"), formally executed by you and Linden Lab.  Terms of
 * the GPL can be found in doc/GPL-license.txt in this distribution, or
 * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
 * 
 * There are special exceptions to the terms and conditions of the GPL as
 * it is applied to this Source Code. View the full text of the exception
 * in the file doc/FLOSS-exception.txt in this software distribution, or
 * online at
 * http://secondlifegrid.net/programs/open_source/licensing/flossexception
 * 
 * By copying, modifying or distributing this software, you acknowledge
 * that you have read and understood your obligations described above,
 * and agree to abide by those obligations.
 * 
 * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
 * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
 * COMPLETENESS OR PERFORMANCE.
 * $/LicenseInfo$
 */

#ifndef LLLIVEAPPCONFIG_H
#define LLLIVEAPPCONFIG_H

#include "llapp.h"
#include "lllivefile.h"


/**
 * @class LLLiveAppConfig
 * @see LLLiveFile
 *
 * To use this, instantiate a LLLiveAppConfig object inside your main
 * loop.  The traditional name for it is live_config.  Be sure to call
 * <code>live_config.checkAndReload()</code> periodically.
 */
class LL_COMMON_API LLLiveAppConfig : public LLLiveFile
{
public:

	/**
	 * @brief Constructor
	 *
	 * @param filename. The name of the file for periodically checking
	 * configuration.
	 * @param refresh_period How often the internal timer should
	 * bother checking the filesystem.
	 * @param The application priority level of that configuration file.
	 */
	LLLiveAppConfig(
		const std::string& filename,
		F32 refresh_period,
		LLApp::OptionPriority priority);

	~LLLiveAppConfig(); ///< Destructor

protected:
	/*virtual*/ bool loadFile();

private:
	LLApp::OptionPriority mPriority;
};

#endif