diff --git a/src/modules/cdp/README b/src/modules/cdp/README index 964afea05d8..148293b4d9f 100644 --- a/src/modules/cdp/README +++ b/src/modules/cdp/README @@ -12,9 +12,17 @@ Edited by Richard Good +Edited by + +Carsten Bock + + ng-voice GmbH + Copyright © 2006 FhG Fokus Copyright © 2012 Smile Communications + + Copyright © 2017 ng-voice GmbH __________________________________________________________________ Table of Contents @@ -35,15 +43,20 @@ Richard Good 4.3. workerq_length_threshold_percentage (int) 4.4. debug_heavy (int) - 5. RPC Commands + 5. Functions + + 5.1. cdp_check_peer(fqdn) + 5.2. cdp_has_app([vendorid, ]application) + + 6. RPC Commands - 5.1. cdp.disable_peer - 5.2. cdp.enable_peer + 6.1. cdp.disable_peer + 6.2. cdp.enable_peer - 6. Configuration Examples + 7. Configuration Examples - 6.1. DiameterPeer.xml example - 6.2. + 7.1. DiameterPeer.xml example + 7.2. 2. Developer Guide @@ -125,7 +138,10 @@ Richard Good 1.2. Set latency_threshold parameter 1.3. Set workerq_length_threshold_percentage parameter 1.4. Set debug_heavy parameter - 1.5. DiameterPeer.xml example + 1.5. cdp_check_peer usage + 1.6. cdp_check_peer usage + 1.7. cdp_check_peer usage + 1.8. DiameterPeer.xml example Chapter 1. Admin Guide @@ -145,15 +161,20 @@ Chapter 1. Admin Guide 4.3. workerq_length_threshold_percentage (int) 4.4. debug_heavy (int) - 5. RPC Commands + 5. Functions - 5.1. cdp.disable_peer - 5.2. cdp.enable_peer + 5.1. cdp_check_peer(fqdn) + 5.2. cdp_has_app([vendorid, ]application) - 6. Configuration Examples + 6. RPC Commands - 6.1. DiameterPeer.xml example - 6.2. + 6.1. cdp.disable_peer + 6.2. cdp.enable_peer + + 7. Configuration Examples + + 7.1. DiameterPeer.xml example + 7.2. 1. Overview @@ -261,32 +282,78 @@ modparam("cdp", "workerq_length_threshold_percentage", 25) modparam("cdp", "debug_heavy", 1) ... -5. RPC Commands +5. Functions + + 5.1. cdp_check_peer(fqdn) + 5.2. cdp_has_app([vendorid, ]application) + +5.1. cdp_check_peer(fqdn) + + The method checks, if a specific peer is connected and ready. + + Meaning of the parameter is as follows: + * fqdn - the Fully qualified domai name of the peer, that should be + checked. The parameter may contain pseudovariables. + + Example 1.5. cdp_check_peer usage +... +if(!cdp_check_peer("hss.mnc001.mcc001.3gppnetwork.org")) { + send_reply("503", "HSS not ready"); + exit; +} +... + +5.2. cdp_has_app([vendorid, ]application) + + The method checks, if any peer with this specific application has + connected. + + Meaning of the parameters are as follows: + * vendorid - The Vendor ID of the App + application - The Application ID + + Example 1.6. cdp_check_peer usage +... +if(!cdp_has_app("10415", "4")) { + send_reply("503", "Charging Server not ready"); + exit; +} +... + + Example 1.7. cdp_check_peer usage +... +if(!cdp_has_app("16777216")) { + send_reply("503", "Cx/Dx Interface not ready"); + exit; +} +... + +6. RPC Commands - 5.1. cdp.disable_peer - 5.2. cdp.enable_peer + 6.1. cdp.disable_peer + 6.2. cdp.enable_peer exported RPC commands. -5.1. cdp.disable_peer +6.1. cdp.disable_peer instantly disable a particular diameter peer. -5.2. cdp.enable_peer +6.2. cdp.enable_peer enabe/re-enable a diameter peer -6. Configuration Examples +7. Configuration Examples - 6.1. DiameterPeer.xml example - 6.2. + 7.1. DiameterPeer.xml example + 7.2. -6.1. DiameterPeer.xml example +7.1. DiameterPeer.xml example This is an example CDP configuration file. The location of this file is configured as a CDP parameter (config_file) - See section 4.1 Above - Example 1.5. DiameterPeer.xml example + Example 1.8. DiameterPeer.xml example