name mode size
..
doc 040000
Makefile 100644 303B
README 100644 6.34kB
dlist.c 100644 8.05kB
dlist.h 100644 2.99kB
hslot.c 100644 3.92kB
hslot.h 100644 2.96kB
ims_usrloc_pcscf_mod.c 100644 8.42kB
ims_usrloc_pcscf_mod.h 100644 2.28kB
pcontact.c 100644 11.86kB
pcontact.h 100644 3.21kB
reginfo.c 100644 2kB
reginfo.h 100644 2.78kB
udomain.c 100644 28.64kB
udomain.h 100644 3.69kB
ul_callback.c 100644 4.75kB
ul_callback.h 100644 3.38kB
ul_rpc.c 100644 5.7kB
ul_rpc.h 100644 2.08kB
usrloc.c 100644 4.88kB
usrloc.h 100644 10.85kB
usrloc_db.c 100644 19.31kB
usrloc_db.h 100644 3.65kB
utime.c 100644 2.06kB
utime.h 100644 2.1kB
README
IMS Usrloc PCSCF Module Jason Penton Smile Communications Edited by Richard Good Smile Communications Edited by Carsten Bock ng-voice GmbH Copyright © 2012 Smile Communications __________________________________________________________________ Table of Contents 1. Admin Guide 1. Overview 2. Dependencies 2.1. Kamailio Modules 2.2. External Libraries or Applications 3. Parameters 3.1. hash_size (int) 3.2. timer_interval (int) 3.3. db_url (int) 3.4. db_mode (int) 3.5. match_contact_host_port (int) 4. RPC Commands 4.1. ulpcscf.status 5. Statistics 5.1. registered contacts 5.2. impus 5.3. expired contacts 2. Frequently Asked Questions List of Examples 1.1. Set hash_size parameter 1.2. Set timer_interval parameter 1.3. Set db_url parameter 1.4. Set db_mode parameter 1.5. Set match_contact_host_port parameter Chapter 1. Admin Guide Table of Contents 1. Overview 2. Dependencies 2.1. Kamailio Modules 2.2. External Libraries or Applications 3. Parameters 3.1. hash_size (int) 3.2. timer_interval (int) 3.3. db_url (int) 3.4. db_mode (int) 3.5. match_contact_host_port (int) 4. RPC Commands 4.1. ulpcscf.status 5. Statistics 5.1. registered contacts 5.2. impus 5.3. expired contacts 1. Overview This module serves as a storage engine for PCSCF contacts, much like the standard Kamailio module, usrloc, is a storage engine for standard SIP contacts. The concept of a contact in IMS, PCSCF specifically, is very different to that of std. SIP and as a result we have built this new module. A lot of the design has been borrowed from the std. usrloc module. For example. An IMS contact, in PCSCF, needs things like: * Diameter Rx session for signalling bearer status. i.e. this is effectively QoS from the network to make sure the signalling link can be 'trusted' * IPSEC Security Association for secure signalling between UE and PCSCF (first point of contact) * IMPU, each contact can have a number of associated public identities (IMPU). 2. Dependencies 2.1. Kamailio Modules 2.2. External Libraries or Applications 2.1. Kamailio Modules The following modules must be loaded before this module: * None. 2.2. External Libraries or Applications The following libraries or applications must be installed before running Kamailio with this module loaded: * None. 3. Parameters 3.1. hash_size (int) 3.2. timer_interval (int) 3.3. db_url (int) 3.4. db_mode (int) 3.5. match_contact_host_port (int) 3.1. hash_size (int) The number of entries of the hash table used by to store the contact records is 2^hash_size. For hash_size=4, the number of entries of the hash table is 16. Default value is 9. Example 1.1. Set hash_size parameter ... modparam("ims_usrloc_pcscf", "hash_size", 10) ... 3.2. timer_interval (int) Number of seconds between two timer runs. The module uses timer to delete expired contacts. Default value is 60. Example 1.2. Set timer_interval parameter ... modparam("ims_usrloc_pcscf", "timer_interval", 30) ... 3.3. db_url (int) Database URL Default value is "mysql://kamailio:kamailiorw@localhost/kamailio". Example 1.3. Set db_url parameter ... modparam("ims_usrloc_pcscf", "db_url", "dbdriver://username:password@dbhost/dbname") ... 3.4. db_mode (int) This is the database mode to be used for the PCSCF usrloc data persistent storage. Currently this module supports the Write-Through scheme only. * 0 - This disables DB mode. Only memory will be used for usrloc and data will not survive a restart. * 1 - Write-Through Scheme. All changes to usrloc are immediately reflected in the database. This is slow but very reliable. This mode will ensure that no registration data is lost as a result of a restart or crash. Default value is 0. Example 1.4. Set db_mode parameter ... modparam("ims_usrloc_pcscf", "db_mode", 1) ... 3.5. match_contact_host_port (int) If set to 1 (default), the contact is matched using only host and port in the contact URI. * 0 - When matching contact do full contact match procedure. * 1 - When matching contact compare only host and port of the contact URI. Default value is 1. Example 1.5. Set match_contact_host_port parameter ... modparam("ims_usrloc_pcscf", "match_contact_host_port", 0) ... 4. RPC Commands 4.1. ulpcscf.status exported RPC commands. 4.1. ulpcscf.status Status of pcscf_usrloc, AORs, max slots, etc. 5. Statistics 5.1. registered contacts 5.2. impus 5.3. expired contacts Exported statistics are listed in the next sections. 5.1. registered contacts Number of AOR contacts in registered state - cannot be reset. 5.2. impus Number of IMPUs - cannot be reset. 5.3. expired contacts Number of expired contacts - can be reset. Chapter 2. Frequently Asked Questions 2.1. Where can I find more about Kamailio? 2.2. Where can I post a question about this module? 2.3. How can I report a bug? 2.1. Where can I find more about Kamailio? Take a look at https://www.kamailio.org/. 2.2. Where can I post a question about this module? First at all check if your question was already answered on one of our mailing lists: * User Mailing List - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users * Developer Mailing List - https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev E-mails regarding any stable Kamailio release should be sent to <sr-users@lists.kamailio.org> and e-mails regarding development versions should be sent to <sr-dev@lists.kamailio.org>. Please report security issues to <management at kamailio dot org>. 2.3. How can I report a bug? Please follow the guidelines provided at: https://github.com/kamailio/kamailio/issues.