Merge branch 'master' of https://github.com/endurox-dev/endurox

Author: endurox-dev

README.md

@@ -14,7 +14,9 @@ EnduroX have binddings for:
 
 Supported operating system: GNU/Linux, starting from 2.6.12 kernel (needed for POSIX Queues). Starting with Enduro/X Version 3.1.2 IBM AIX (6.1 and 7.1), Oracle Solaris 11, MAC OS X (experimental) and Cygwin (experimental) support is added. Supported compilers: gcc, LLVM clang, IBM xlC.
 
-- Build and installation guides are located at: http://www.endurox.org
+- Build and installation guides are located at: www.endurox.org/dokuwiki
+ 
+- Support forum: www.endurox.org
 
 - Binary builds (RPMs & DEBs) for various platforms are here: http://www.endurox.org/projects/endurox/files
 

cconfsrv/Makefile

@@ -37,11 +37,11 @@ find_program(DBLATEX "dblatex")
 set(PDF_NAMES ex_devguide ex_overview ex_adminman building_guide 
                        getting_started_tutorial persistent_message_queues_overview
                         osx_notes aix_notes solaris_notes freebsd_notes
-						benchmark)
+						benchmark common_configuration)
 set(HTML_NAMES ex_devguide ex_overview ex_adminman building_guide
                        getting_started_tutorial persistent_message_queues_overview
                         osx_notes aix_notes solaris_notes freebsd_notes
-						benchmark)
+						benchmark common_configuration)
 
 # Generate PDFs...
 if(DBLATEX)

doc/CMakeLists.txt

@@ -0,0 +1,44 @@
+Common Configuration
+====================
+Madars Vitolins
+v1.0, 2016-09:
+	Initial draft
+:doctype: book
+
+About the guide
+---------------
+This document describes new configuration principles used in Enduro/X. The configuration is based on
+ini files, the in 3.x series the old style configuration files (ndrxdebug.conf, q.conf) are still supported,
+but the same format data can be now passed into ini files.
+
+== Moving environment variables to ini files
+
+Enduro/X depend on set of the environment variables which define the basic settings for application server to
+start to work. These includes various shared memory settings, queue settings, etc. See the ex_env(5) page for that.
+
+The set of environment variables means that users needs to maintain and set them some how. With the common-configuration
+framework, these variables can be defined in ini file in '[@global]' section. When the Enduro/X initializes standard library,
+it is searching for 'NDRX_CCONFIG' environment variable presence. If the variable is present, Enduro/X loads into memory
+sections which are needed for later processing. From these sections settings from [@global] is automatically loaded
+as environment variables for current processing, by using system call 'setenv()'. Thus in this section you may define 
+any environment variables you want to see for process which is started.
+
+== Conclusions
+TODO
+
+:numbered!:
+
+[bibliography]
+Additional documentation 
+------------------------
+This section lists additional related documents.
+
+[bibliography]
+.Resources
+- [[[ex_env.5]]] Man page for Enduro/X environment variables.
+
+
+////////////////////////////////////////////////////////////////
+The index is normally left completely empty, it's contents being
+generated automatically by the DocBook toolchain.
+////////////////////////////////////////////////////////////////

doc/common_configuration.adoc

@@ -24,9 +24,8 @@ XATMI service calls.
 
 API - get section
 -----------------
-The server can work in two modes.
 
-1. Get mode ('EX_CC_CMD' UBF buffer set to 'g' (default)). In this mode the request for configuration is made for particular
+Get mode ('EX_CC_CMD' UBF buffer set to 'g' (default)). In this mode the request for configuration is made for particular
 section.  The config files (or directories) for which to do the lookup can be set in 'EX_CC_RESOURCE' field, you may use
 multiple occurrences. If field is not set, then lookup is done in all files which are loaded into configuration library. This
 includes Enduro/X own config files, which are set in *NDRX_CCONFIG* environment variables (see ex_env(5)). The get request
@@ -95,15 +94,40 @@ It is possible request format verification. The key-format fields are used into
 
 *nX..Y* or *n..Y* (e.g. n2..5, n..3) - Numeric field (can be floating point format). Min length X (measured as string) and max length Y (measured as string).
 
-2. Second mode for configuration server is requesting a config listing. This enters service in conversational mode. The configuration listing mode is requested by setting 'EX_CC_CMD' to 'l'.
+API - list sections
+-------------------
+It is possible to enter in conversational mode in request sections which begins with certain phrase 
+or it is possible to list all sections for given resources. To enter is list mode you need to call
+the configuration server with 'EX_CC_CMD' UBF buffer field set 'l'. If this is the only field
+then all sections from default Enduro/X configuration files will be returned.
+
+The sections which starts with phrase can be set in 'EX_CC_LOOKUPSECTION' UBF field occurrences. Resource
+to lookup can be specified in 'EX_CC_RESOURCE'.
 
 EXIT STATUS
 -----------
-*0*::
-Success
+When error occurs, the configuration service returns *TPESVCFAIL*, and 'EX_NERROR_CODE' is set to corresponding
+error code. 'EX_NERROR_MSG' have some additional information about error condition.
+
+*EX_NERROR_CODE* values:
+
+*1* Invalid INI file(s).
+
+*2* Malloc failed (system have low of memory or some kind of other system related problem).
+
+*3* Unix error occurred.
 
-*1*::
-Failure
+*4* Invalid arguments passed.
+
+*5* System failure.
+
+*6* Mandatory field is missing. 'EX_NERROR_MSG' specifies the exact problematic field.
+
+*7* Field value format error. 'EX_NERROR_MSG' specifies the exact problematic field.
+
+EXAMPLE
+-------
+See *atmitest/test030_cconfsrv/atmiclt30.c* for sample code.
 
 BUGS
 ----