Add CEA on server session configuration for services
[anna.git] / example / diameter / launcher / resources / services_examples / services.dtd
index 00808a4..27cd9ea 100755 (executable)
 -->
 
 <!ELEMENT node EMPTY>
-<!ATTLIST node originHost CDATA #REQUIRED applicationId CDATA #REQUIRED originRealm CDATA #IMPLIED cer CDATA #IMPLIED dwr CDATA #IMPLIED allowedInactivityTime CDATA #IMPLIED tcpConnectDelay CDATA #IMPLIED answersTimeout CDATA #IMPLIED ceaTimeout CDATA #IMPLIED watchdogPeriod CDATA #IMPLIED entity CDATA #IMPLIED entityServerSessions CDATA #IMPLIED diameterServer CDATA #IMPLIED diameterServerSessions CDATA #IMPLIED balance (yes | no) #IMPLIED sessionBasedModelsClientSocketSelection (SessionIdLowPart | SessionIdHighPart | SessionIdOptionalPart | RoundRobin) #IMPLIED retries CDATA #IMPLIED log CDATA #IMPLIED splitLog (yes | no) #IMPLIED detailedLog (yes | no) #IMPLIED dumpLog (yes | no) #IMPLIED burstLog (yes | no) #IMPLIED>
+<!ATTLIST node originHost CDATA #REQUIRED applicationId CDATA #REQUIRED originRealm CDATA #IMPLIED cer CDATA #IMPLIED dwr CDATA #IMPLIED cea CDATA #IMPLIED allowedInactivityTime CDATA #IMPLIED tcpConnectDelay CDATA #IMPLIED answersTimeout CDATA #IMPLIED ceaTimeout CDATA #IMPLIED watchdogPeriod CDATA #IMPLIED entity CDATA #IMPLIED entityServerSessions CDATA #IMPLIED diameterServer CDATA #IMPLIED diameterServerSessions CDATA #IMPLIED balance (yes | no) #IMPLIED sessionBasedModelsClientSocketSelection (SessionIdLowPart | SessionIdHighPart | SessionIdOptionalPart | RoundRobin) #IMPLIED retries CDATA #IMPLIED log CDATA #IMPLIED splitLog (yes | no) #IMPLIED detailedLog (yes | no) #IMPLIED dumpLog (yes | no) #IMPLIED burstLog (yes | no) #IMPLIED>
 <!--
    Node record
 
    originHost:                              Node identifier as diameter application host name.
    applicationId:                           The Application-Id provided must exists as a registered 'stack id'.
    originRealm:                             Origin-Realm (domain-name internally used by default).
+
+
+   - Diameter clients:
+
+   entity:                                  Target diameter entity (comma-separated '<address>:<port>' format).
+                                            For example: 10.20.30.40:3868,10.20.30.41:3868. If missing, no entity will be enabled.
+   entityServerSessions:                    Diameter entity server sessions (0: diameter entity disabled). Default value of 1.
    cer:                                     User defined CER path file to be encoded to establish diameter connections.
                                             If missing, will be harcoded.
    dwr:                                     User defined DWR path file to be encoded for diameter protocol keep alive.
                                             If missing, will be harcoded.
-   allowedInactivityTime:                   Milliseconds for the maximum allowed inactivity time on server sessions born over the
-                                            local server before being reset. If missing, default value of 90000 will be assigned.
    tcpConnectDelay:                         Milliseconds to wait TCP connect to any server. If missing, default value of 200 will
-                                            be assigned.
-   answersTimeout:                          Milliseconds to wait pending application answers from diameter peers. If missing,
-                                            default value of 10000 will be assigned.
+                                            be assigned
    ceaTimeout:                              Milliseconds to wait CEA from diameter server. If missing, default value of 'answersTimeout'
                                             will be assigned.
    watchdogPeriod:                          Milliseconds for watchdog timer (Tw) for diameter keep-alive procedure. If missing, default
                                             value of 30000 will be assigned.
-   entity:                                  Target diameter entity (comma-separated '<address>:<port>' format).
-                                            For example: 10.20.30.40:3868,10.20.30.41:3868. If missing, no entity will be enabled.
-   entityServerSessions:                    Diameter entity server sessions (0: diameter entity disabled). Default value of 1.
-   diameterServer:                          Diameter own server address in '<address>:<port>' format. For example: 10.20.30.40:3868.
-                                            If missing, no local server will be enabled.
-   diameterServerSessions:                  Diameter own server available connections (0: diameter server disabled). Default value of 1.
-                                            Negative value implies no limit accepting incoming connections.
    balance:                                 Balance over entity servers instead of doing standard behaviour (first primary, secondary
                                             if fails, etc.). Default value 'no'.
    sessionBasedModelsClientSocketSelection: By default, round-robin will be applied for IEC model (SMS/MMS), and Session-Id Low Part
                                             will be analyzed for ECUR/SCUR model (data, voice and content). You could change ECUR/SCUR
                                             analysis behaviour providing 'SessionIdHighPart', 'SessionIdOptionalPart' (atoi applied;
-                                            usually subscriber id data, i.e. MSISDN or IMSI) and 'RoundRobin' (also 'SessionIdLowPart')
+                                            usually subscriber id data, i.e. MSISDN or IMSI) and 'RoundRobin' (also 'SessionIdLowPart').
+
+
+   - Diameter servers:
+
+   diameterServer:                          Diameter own server address in '<address>:<port>' format. For example: 10.20.30.40:3868.
+                                            If missing, no local server will be enabled.
+   diameterServerSessions:                  Diameter own server available connections (0: diameter server disabled). Default value of 1.
+                                            Negative value implies no limit accepting incoming connections.
+   cea:                                     User defined CEA path file to be encoded to answer client CERs.
+                                            If missing, will be harcoded.
+   allowedInactivityTime:                   Milliseconds for the maximum allowed inactivity time on server sessions born over the
+                                            local server before being reset. If missing, default value of 90000 will be assigned.
+
+
+   - General:
+
+   answersTimeout:                          Milliseconds to wait pending application answers from diameter peers. If missing,
+                                            default value of 10000 will be assigned.
    retries:                                 Expired responses will cause a number of request retransmissions. Disabled by default (0 retries).
    log:                                     Process log file (operations result, traffic log, etc.). By default '<originHost>.launcher.log'.
-                                            Empty string or "null" name, to disable. Warning: there is no rotation for log files
+                                            Empty string or \"null\" name, to disable. Warning: there is no rotation for log files
                                             (use logrotate or whatever you consider).
    splitLog:                                Splits log file (appends to log filename, extensions with the type of event: see help on
                                             startup information-level traces). No log files for code/decode and load operations are created.
@@ -65,7 +79,7 @@
    dumpLog:                                 Write to disk every incoming/outcoming message named as:
                                                '<unix ms timestamp>.<originHost>.<hop by hop>.<end to end>.<message code>.<request|answer>.<type of event>.xml'
                                             Default value 'no'.
-   burstLog:                                Burst operations log file. By default '<originHost>.launcher.burst'. Empty string or "null" name, to disable.
+   burstLog:                                Burst operations log file. By default '<originHost>.launcher.burst'. Empty string or \"null\" name, to disable.
                                             Warning: there is no rotation for log files (use logrotate or whatever). Output: dot (.) for each
                                             burst message sent/pushed, cross (x) for popped ones, and order number when multiple of 1% of burst
                                             list size, plus OTA requests when changed.