Skip to content

Commit ad18d53

Browse files
committed
Works on cconfsrv manpage
1 parent 206b55c commit ad18d53

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

doc/manpage/cconfsrv.adoc

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,10 @@ NAME
77
----
88
cconfsrv - Common configuration server
99

10-
1110
SYNOPSIS
1211
--------
1312
*cconfsrv*
1413

15-
1614
DESCRIPTION
1715
-----------
1816
This is sepcial XATMI server shipped with Enduro/X in order to provide common-configuration (ini file) parsing facilities
@@ -21,7 +19,7 @@ uses XATMI API (exposed as service) in order to get configuration section or lis
2119
application.
2220

2321
This server is optional and can be used by third party application in oder to read the configuration files via standard
24-
XATMi service calls.
22+
XATMI service calls.
2523

2624

2725
API - get section
@@ -79,9 +77,23 @@ EX_CC_KEY PARAM5
7977
EX_CC_VALUE value5
8078
--------------------------------------------------------------------------------
8179

82-
Mention taht 'PARAM3' value is set to 'value4' and not 'value3', because 'TEST1/SUB1/SUB2' closer matched the lookup request.
80+
Mention that 'PARAM3' value is set to 'value4' and not 'value3', because 'TEST1/SUB1/SUB2' closer matched the lookup request.
8381
The principle is that all parent variables are gathered. If any variable is common between parent and child, then child element
84-
will be returned, as it is with higher prioirity.
82+
will be returned, as it is with higher priority.
83+
84+
When doing requests to configuration server it is possible to request for mandatory field keys checking. The must-have keys are loaded into 'EX_CC_MANDATORY' field occurrences. If during section lookup key is not found, then error '6' is returned.
85+
86+
It is possible request format verification. The key-format fields are used into 'EX_CC_FORMAT_KEY' + 'EX_CC_FORMAT_FORMAT' occurrences. If the format does not match field, error code '7' is returned.
87+
88+
*'EX_CC_FORMAT_FORMAT' field can have following values:*
89+
90+
*t* - Boolean field, valid values starts with on of the following symbols: 'TtFfYyNn10'.
91+
92+
*sX..Y* or *s..Y* (e.g. s10..20, s..5) - String field, min length X and max length Y. If X is not set (second format), then X is assumed to be 0.
93+
94+
*iX..Y* or *i..Y* (e.g. i1..2, i..3) - Integer field, min len (measured as string) X and max len (measured as string Y.
95+
96+
*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).
8597

8698
EXIT STATUS
8799
-----------

0 commit comments

Comments
 (0)