Changes between Version 3 and Version 4 of Documentation/Configuration

Timestamp:

Feb 4, 2010, 5:01:20 PM (15 years ago)

Author:

Christoph Mayer

Comment:

--

Documentation/Configuration

@@ -1 +1 @@
 = Configuration = 
 
-The pingpong sample uses a text-based configuration file for reading parameters like local endpoints to use or bootstrapping information. This information is then set e.g. in the {{{AribaModule}}} when starting up. Therefore, using a configuration file is optional, you can use your own configuration file format or hardcode such information in your code.
+The pingpong sample uses a text-based configuration file for reading parameters like local endpoints to use or bootstrapping information. This information is then set e.g. using {{{AribaModule::setProperty}}} when starting up. Therefore, using a configuration file is optional, you can use your own configuration file format or hardcode such information in your code.
+
+== !AribaModule Properties ==
+
+Currently the !AribaModule class supports two properties that can be set
+ * {{{endpoints}}}
+ * {{{bootstrap.hints}}}
+All other information -- like node names or spovnet names are set directly using the Ariba interface (see e.g. {{{PingPong.cpp}}}). 
+
+The {{{endpoints}}} property defines the local endpoints where Ariba opens up server instances. If you don't configure the endpoints defaults will be used. A detailed description of the endpoint format is given further down. The {{{bootstrap.hints}}} property defines bootstrapping information the node uses to find the SpoVNet instance. This can either be static nodes or automatic bootstrap modules like mDNS. Again, see further down this page for a description of the bootstrap hints format.
 
 == Configuration class ==
 
+If you want to read information from a settings file, you can use the built-in {{{Configuration}}} class. To define the filename, use the 
+{{{
+StartupWrapper::initConfig( config );
+}}}
+function, as in the {{{main.cpp}}} of the !PingPong sample. The given configuration file will be read and is accessible throughout the whole process. You can check if there is a configuration file available using
+{{{
+if( Configuration::haveConfig() )
+}}}
+and get a reference to the configuration singleton using
+{{{
+Configuration& config = Configuration::instance();
+}}}
+
+The format of the configuration file is one item per line using
+{{{
+name = value
+}}}
+where value can be a string, integer, or {{{true|false}}}. Reading from the configuration file is parametrized using the desired type:
+{{{
+string name = config.read<string>("name");
+int count = config.read<int>("count");
+bool enable = config.read<bool>("enable");
+}}}