1 | // |
---|
2 | // Environment.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Foundation/include/Poco/Environment.h#4 $ |
---|
5 | // |
---|
6 | // Library: Foundation |
---|
7 | // Package: Core |
---|
8 | // Module: Environment |
---|
9 | // |
---|
10 | // Definition of the Environment class. |
---|
11 | // |
---|
12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef Foundation_Environment_INCLUDED |
---|
40 | #define Foundation_Environment_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Foundation.h" |
---|
44 | |
---|
45 | |
---|
46 | namespace Poco { |
---|
47 | |
---|
48 | |
---|
49 | class Foundation_API Environment |
---|
50 | /// This class provides access to environment variables |
---|
51 | /// and some general system information. |
---|
52 | { |
---|
53 | public: |
---|
54 | typedef UInt8 NodeId[6]; /// Ethernet address. |
---|
55 | |
---|
56 | static std::string get(const std::string& name); |
---|
57 | /// Returns the value of the environment variable |
---|
58 | /// with the given name. Throws a NotFoundException |
---|
59 | /// if the variable does not exist. |
---|
60 | |
---|
61 | static std::string get(const std::string& name, const std::string& defaultValue); |
---|
62 | /// Returns the value of the environment variable |
---|
63 | /// with the given name. If the environment variable |
---|
64 | /// is undefined, returns defaultValue instead. |
---|
65 | |
---|
66 | static bool has(const std::string& name); |
---|
67 | /// Returns true iff an environment variable |
---|
68 | /// with the given name is defined. |
---|
69 | |
---|
70 | static void set(const std::string& name, const std::string& value); |
---|
71 | /// Sets the environment variable with the given name |
---|
72 | /// to the given value. |
---|
73 | |
---|
74 | static std::string osName(); |
---|
75 | /// Returns the operating system name. |
---|
76 | |
---|
77 | static std::string osVersion(); |
---|
78 | /// Returns the operating system version. |
---|
79 | |
---|
80 | static std::string osArchitecture(); |
---|
81 | /// Returns the operating system architecture. |
---|
82 | |
---|
83 | static std::string nodeName(); |
---|
84 | /// Returns the node (or host) name. |
---|
85 | |
---|
86 | static void nodeId(NodeId& id); |
---|
87 | /// Returns the Ethernet address of the first Ethernet |
---|
88 | /// adapter found on the system. |
---|
89 | /// |
---|
90 | /// Throws a SystemException if no Ethernet adapter is available. |
---|
91 | |
---|
92 | static std::string nodeId(); |
---|
93 | /// Returns the Ethernet address (format "xx:xx:xx:xx:xx:xx") |
---|
94 | /// of the first Ethernet adapter found on the system. |
---|
95 | /// |
---|
96 | /// Throws a SystemException if no Ethernet adapter is available. |
---|
97 | |
---|
98 | static unsigned processorCount(); |
---|
99 | /// Returns the number of processors installed in the system. |
---|
100 | /// |
---|
101 | /// If the number of processors cannot be determined, returns 1. |
---|
102 | |
---|
103 | static Poco::UInt32 libraryVersion(); |
---|
104 | /// Returns the POCO C++ Libraries version as a hexadecimal |
---|
105 | /// number in format 0xAABBCCDD, where |
---|
106 | /// - AA is the major version number, |
---|
107 | /// - BB is the minor version number, |
---|
108 | /// - CC is the revision number, and |
---|
109 | /// - DD is the patch level number. |
---|
110 | }; |
---|
111 | |
---|
112 | |
---|
113 | } // namespace Poco |
---|
114 | |
---|
115 | |
---|
116 | #endif // Foundation_Environment_INCLUDED |
---|