new file mode 100644

@@ -0,0 +1,19 @@

+# $Id$

+#

+# Usrloc_pcscf module Makefile

+#

+# 

+# WARNING: do not run this directly, it should be run by the master Makefile

+

+include ../../Makefile.defs

+auto_gen=

+NAME=usrloc_pcscf.so

+

+DEFS+=-DOPENSER_MOD_INTERFACE

+

+SERLIBPATH=../../lib

+SER_LIBS+=$(SERLIBPATH)/kmi/kmi

+SER_LIBS+=$(SERLIBPATH)/srdb1/srdb1

+SER_LIBS+=$(SERLIBPATH)/kcore/kcore

+#SER_LIBS+=$(SERLIBPATH)/srutils/srutils

+include ../../Makefile.modules

new file mode 100644

@@ -0,0 +1,44 @@

+/*

+ * $Id$

+ *

+ * Copyright (C) 2012 Smile Communications, jason.penton@smilecoms.com

+ * Copyright (C) 2012 Smile Communications, richard.good@smilecoms.com

+ * 

+ * The initial version of this code was written by Dragos Vingarzan

+ * (dragos(dot)vingarzan(at)fokus(dot)fraunhofer(dot)de and the

+ * Fruanhofer Institute. It was and still is maintained in a separate

+ * branch of the original SER. We are therefore migrating it to

+ * Kamailio/SR and look forward to maintaining it from here on out.

+ * 2011/2012 Smile Communications, Pty. Ltd.

+ * ported/maintained/improved by 

+ * Jason Penton (jason(dot)penton(at)smilecoms.com and

+ * Richard Good (richard(dot)good(at)smilecoms.com) as part of an 

+ * effort to add full IMS support to Kamailio/SR using a new and

+ * improved architecture

+ * 

+ * NB: Alot of this code was originally part of OpenIMSCore,

+ * FhG Fokus. 

+ * Copyright (C) 2004-2006 FhG Fokus

+ * Thanks for great work! This is an effort to 

+ * break apart the various CSCF functions into logically separate

+ * components. We hope this will drive wider use. We also feel

+ * that in this way the architecture is more complete and thereby easier

+ * to manage in the Kamailio/SR environment

+ *

+ * This file is part of Kamailio, a free SIP server.

+ *

+ * Kamailio is free software; you can redistribute it and/or modify

+ * it under the terms of the GNU General Public License as published by

+ * the Free Software Foundation; either version 2 of the License, or

+ * (at your option) any later version

+ *

+ * Kamailio is distributed in the hope that it will be useful,

+ * but WITHOUT ANY WARRANTY; without even the implied warranty of

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU General Public License for more details.

+ *

+ * You should have received a copy of the GNU General Public License 

+ * along with this program; if not, write to the Free Software 

+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

+ * 

+ */

\ No newline at end of file

new file mode 100644

@@ -0,0 +1,346 @@

+/*

+ * $Id$

+ *

+ * Copyright (C) 2012 Smile Communications, jason.penton@smilecoms.com

+ * Copyright (C) 2012 Smile Communications, richard.good@smilecoms.com

+ * 

+ * The initial version of this code was written by Dragos Vingarzan

+ * (dragos(dot)vingarzan(at)fokus(dot)fraunhofer(dot)de and the

+ * Fruanhofer Institute. It was and still is maintained in a separate

+ * branch of the original SER. We are therefore migrating it to

+ * Kamailio/SR and look forward to maintaining it from here on out.

+ * 2011/2012 Smile Communications, Pty. Ltd.

+ * ported/maintained/improved by 

+ * Jason Penton (jason(dot)penton(at)smilecoms.com and

+ * Richard Good (richard(dot)good(at)smilecoms.com) as part of an 

+ * effort to add full IMS support to Kamailio/SR using a new and

+ * improved architecture

+ * 

+ * NB: Alot of this code was originally part of OpenIMSCore,

+ * FhG Fokus. 

+ * Copyright (C) 2004-2006 FhG Fokus

+ * Thanks for great work! This is an effort to 

+ * break apart the various CSCF functions into logically separate

+ * components. We hope this will drive wider use. We also feel

+ * that in this way the architecture is more complete and thereby easier

+ * to manage in the Kamailio/SR environment

+ *

+ * This file is part of Kamailio, a free SIP server.

+ *

+ * Kamailio is free software; you can redistribute it and/or modify

+ * it under the terms of the GNU General Public License as published by

+ * the Free Software Foundation; either version 2 of the License, or

+ * (at your option) any later version

+ *

+ * Kamailio is distributed in the hope that it will be useful,

+ * but WITHOUT ANY WARRANTY; without even the implied warranty of

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU General Public License for more details.

+ *

+ * You should have received a copy of the GNU General Public License 

+ * along with this program; if not, write to the Free Software 

+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

+ * 

+ */

+

+#include "dlist.h"

+#include <stdlib.h>	       /* abort */

+#include <string.h>            /* strlen, memcmp */

+#include <stdio.h>             /* printf */

+#include "../../ut.h"

+#include "../../lib/srdb1/db_ut.h"

+#include "../../mem/shm_mem.h"

+#include "../../dprint.h"

+#include "../../ip_addr.h"

+#include "../../socket_info.h"

+#include "udomain.h"           /* new_udomain, free_udomain */

+#include "usrloc.h"

+#include "utime.h"

+#include "ul_mod.h"

+#include "pcontact.h"

+

+dlist_t* root = 0;

+

+static inline int find_dlist(str* _n, dlist_t** _d)

+{

+	dlist_t* ptr;

+

+	ptr = root;

+	while(ptr) {

+		if ((_n->len == ptr->name.len) &&

+		    !memcmp(_n->s, ptr->name.s, _n->len)) {

+			*_d = ptr;

+			return 0;

+		}

+		

+		ptr = ptr->next;

+	}

+	

+	return 1;

+}

+

+static inline int get_all_mem_ucontacts(void *buf, int len, unsigned int flags,

+							unsigned int part_idx, unsigned int part_max)

+{

+	dlist_t *p;

+	pcontact_t *c;

+	void *cp;

+	int shortage;

+	int needed;

+	int i = 0;

+	cp = buf;

+	shortage = 0;

+	unsigned int received_len = 0;

+	char received_s[60]; // IPv6-Address (39) + "sip:" (4) + ":" (1) + Port (5); 60 should be plenty.

+	/* Reserve space for terminating 0000 */

+	len -= sizeof(int);

+

+	for (p = root; p != NULL; p = p->next) {

+

+		for(i=0; i<p->d->size; i++) {

+

+			if ( (i % part_max) != part_idx )

+				continue;

+

+			lock_ulslot(p->d, i);

+			if(p->d->table[i].n<=0)

+			{

+				unlock_ulslot(p->d, i);

+				continue;

+			}

+			for (c = p->d->table[i].first; c != NULL; c = c->next) {

+					if (c->received_host.s) {

+						received_len = snprintf(received_s, sizeof(received_s), "sip:%.*s:%x", c->received_host.len,

+							c->received_host.s, c->received_port) - 1; 

+

+						needed = (int)(sizeof(received_len)

+								+ received_len + sizeof(c->sock)

+								+ sizeof(unsigned int) + sizeof(c->path.len)

+								+ c->path.len);

+						if (len >= needed) {

+							cp = (char*)cp + received_len;

+							cp = (char*)cp + sizeof(received_len);

+

+							memcpy(cp, received_s, received_len);

+							cp = (char*)cp + received_len;

+

+							memcpy(cp, &c->sock, sizeof(c->sock));

+							cp = (char*)cp + sizeof(c->sock);

+

+							memset(cp, 0, sizeof(unsigned int));

+							cp = (char*)cp + sizeof(unsigned int);

+

+							memcpy(cp, &c->path.len, sizeof(c->path.len));

+							cp = (char*)cp + sizeof(c->path.len);

+							memcpy(cp, c->path.s, c->path.len);

+							cp = (char*)cp + c->path.len;

+							len -= needed;

+						} else {

+							shortage += needed;

+						}

+					}

+			}

+			unlock_ulslot(p->d, i);

+		}

+	}

+	/* len < 0 is possible, if size of the buffer < sizeof(c->c.len) */

+	if (len >= 0)

+		memset(cp, 0, sizeof(int));

+

+	/* Shouldn't happen */

+	if (shortage > 0 && len > shortage) {

+		abort();

+	}

+

+	shortage -= len;

+

+	return shortage > 0 ? shortage : 0;

+}

+

+int get_all_ucontacts(void *buf, int len, unsigned int flags,

+								unsigned int part_idx, unsigned int part_max)

+{

+	return get_all_mem_ucontacts( buf, len, flags, part_idx, part_max);

+}

+

+static inline int new_dlist(str* _n, dlist_t** _d)

+{

+	dlist_t* ptr;

+

+	/* Domains are created before ser forks,

+	 * so we can create them using pkg_malloc

+	 */

+	ptr = (dlist_t*)shm_malloc(sizeof(dlist_t));

+	if (ptr == 0) {

+		LM_ERR("no more share memory\n");

+		return -1;

+	}

+	memset(ptr, 0, sizeof(dlist_t));

+

+	/* copy domain name as null terminated string */

+	ptr->name.s = (char*)shm_malloc(_n->len+1);

+	if (ptr->name.s == 0) {

+		LM_ERR("no more memory left\n");

+		shm_free(ptr);

+		return -2;

+	}

+

+	memcpy(ptr->name.s, _n->s, _n->len);

+	ptr->name.len = _n->len;

+	ptr->name.s[ptr->name.len] = 0;

+

+	if (new_udomain(&(ptr->name), ul_hash_size, &(ptr->d)) < 0) {

+		LM_ERR("creating domain structure failed\n");

+		shm_free(ptr->name.s);

+		shm_free(ptr);

+		return -3;

+	}

+

+	*_d = ptr;

+	return 0;

+}

+

+int get_udomain(const char* _n, udomain_t** _d)

+{

+	dlist_t* d;

+	str s;

+

+	s.s = (char*)_n;

+	s.len = strlen(_n);

+

+	if (find_dlist(&s, &d) == 0) {

+		*_d = d->d;

+		return 0;

+	}

+	*_d = NULL;

+	return -1;

+}

+

+int register_udomain(const char* _n, udomain_t** _d)

+{

+	dlist_t* d;

+	str s;

+

+	s.s = (char*)_n;

+	s.len = strlen(_n);

+

+	if (find_dlist(&s, &d) == 0) {

+		*_d = d->d;

+		return 0;

+	}

+	

+	if (new_dlist(&s, &d) < 0) {

+		LM_ERR("failed to create new domain\n");

+		return -1;

+	}

+

+	d->next = root;

+	root = d;

+	

+	*_d = d->d;

+	return 0;

+}

+

+void free_all_udomains(void)

+{

+	dlist_t* ptr;

+

+	while(root) {

+		ptr = root;

+		root = root->next;

+

+		free_udomain(ptr->d);

+		shm_free(ptr->name.s);

+		shm_free(ptr);

+	}

+}

+

+void print_all_udomains(FILE* _f)

+{

+	dlist_t* ptr;

+	

+	ptr = root;

+

+	fprintf(_f, "===Domain list===\n");

+	while(ptr) {

+		print_udomain(_f, ptr->d);

+		ptr = ptr->next;

+	}

+	fprintf(_f, "===/Domain list===\n");

+}

+

+int synchronize_all_udomains(void)

+{

+	int res = 0;

+	dlist_t* ptr;

+

+	get_act_time(); /* Get and save actual time */

+

+	for( ptr=root ; ptr ; ptr=ptr->next)

+		mem_timer_udomain(ptr->d);

+

+	return res;

+}

+

+int find_domain(str* _d, udomain_t** _p)

+{

+	dlist_t* d;

+

+	if (find_dlist(_d, &d) == 0) {

+	        *_p = d->d;

+		return 0;

+	}

+

+	return 1;

+}

+

+unsigned long get_number_of_contacts(void)

+{

+        long numberOfUsers = 0;

+

+        dlist_t* current_dlist;

+

+        current_dlist = root;

+

+        while (current_dlist)

+        {

+                numberOfUsers += get_stat_val(current_dlist->d->contacts);

+                current_dlist  = current_dlist->next;

+        }

+

+        return numberOfUsers;

+}

+

+unsigned long get_number_of_expired(void)

+{

+        long numberOfExpired = 0;

+

+        dlist_t* current_dlist;

+

+        current_dlist = root;

+

+        while (current_dlist)

+        {

+                numberOfExpired += get_stat_val(current_dlist->d->expired);

+                current_dlist  = current_dlist->next;

+        }

+

+        return numberOfExpired;

+}

+

+unsigned long get_number_of_impu(void)

+{

+        long numberOfExpired = 0;

+

+        dlist_t* current_dlist;

+

+        current_dlist = root;

+

+        while (current_dlist)

+        {

+                numberOfExpired += get_stat_val(current_dlist->d->expired);

+                current_dlist  = current_dlist->next;

+        }

+

+        return numberOfExpired;

+}

new file mode 100644

@@ -0,0 +1,82 @@

+/*

+ * $Id$

+ *

+ * Copyright (C) 2012 Smile Communications, jason.penton@smilecoms.com

+ * Copyright (C) 2012 Smile Communications, richard.good@smilecoms.com

+ * 

+ * The initial version of this code was written by Dragos Vingarzan

+ * (dragos(dot)vingarzan(at)fokus(dot)fraunhofer(dot)de and the

+ * Fruanhofer Institute. It was and still is maintained in a separate

+ * branch of the original SER. We are therefore migrating it to

+ * Kamailio/SR and look forward to maintaining it from here on out.

+ * 2011/2012 Smile Communications, Pty. Ltd.

+ * ported/maintained/improved by 

+ * Jason Penton (jason(dot)penton(at)smilecoms.com and

+ * Richard Good (richard(dot)good(at)smilecoms.com) as part of an 

+ * effort to add full IMS support to Kamailio/SR using a new and

+ * improved architecture

+ * 

+ * NB: Alot of this code was originally part of OpenIMSCore,

+ * FhG Fokus. 

+ * Copyright (C) 2004-2006 FhG Fokus

+ * Thanks for great work! This is an effort to 

+ * break apart the various CSCF functions into logically separate

+ * components. We hope this will drive wider use. We also feel

+ * that in this way the architecture is more complete and thereby easier

+ * to manage in the Kamailio/SR environment

+ *

+ * This file is part of Kamailio, a free SIP server.

+ *

+ * Kamailio is free software; you can redistribute it and/or modify

+ * it under the terms of the GNU General Public License as published by

+ * the Free Software Foundation; either version 2 of the License, or

+ * (at your option) any later version

+ *

+ * Kamailio is distributed in the hope that it will be useful,

+ * but WITHOUT ANY WARRANTY; without even the implied warranty of

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU General Public License for more details.

+ *

+ * You should have received a copy of the GNU General Public License 

+ * along with this program; if not, write to the Free Software 

+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

+ * 

+ */

+

+#ifndef DLIST_H

+#define DLIST_H

+

+#include <stdio.h>

+#include "../../str.h"

+#include "usrloc.h"

+#include "udomain.h"

+

+/*!

+ * List of all domains registered with usrloc

+ */

+typedef struct dlist {

+	str name;            /*!< Name of the domain (null terminated) */

+	udomain_t* d;        /*!< Payload */

+	struct dlist* next;  /*!< Next element in the list */

+} dlist_t;

+

+/*! \brief Global list of all registered domains */

+extern dlist_t* root;

+

+int register_udomain(const char* _n, udomain_t** _d);

+void free_all_udomains(void);

+void print_all_udomains(FILE* _f);

+int synchronize_all_udomains(void);

+int get_all_ucontacts(void *buf, int len, unsigned int flags,

+		unsigned int part_idx, unsigned int part_max);

+int get_udomain(const char* _n, udomain_t** _d);

+unsigned long get_number_of_users(void);

+int find_domain(str* _d, udomain_t** _p);

+

+/* stat retrieval functions */

+unsigned long get_number_of_contacts(void);

+unsigned long get_number_of_expired(void);

+unsigned long get_number_of_impu(void);

+

+

+#endif

new file mode 100644

@@ -0,0 +1,4 @@

+docs = usrloc_pcscf.xml

+

+docbook_dir = ../../../docbook

+include $(docbook_dir)/Makefile.module

new file mode 100644

@@ -0,0 +1,72 @@

+/** Full Diameter Peer configuration. */

+typedef struct {

+	str fqdn;					/**< own FQDN */

+	str realm;					/**< own Realm */

+	str identity;				/**< own diameter URI */

+	int vendor_id;				/**< own vendorid */

+	str product_name;			/**< own product name */

+	int accept_unknown_peers;	/**< if to accept connections from peers that are not configured initially */

+	int drop_unknown_peers;		/**< if to drop the peers that are not initially configured on disconnected;

+									 usually, you want to do this, unless you want your list of peers to

+									 grow and you want to try and connect back to everybody that connected 

+									 to you before */

+	int tc;						/**< Tc timer duration (30 seconds should be) */

+	int workers;				/**< Number of worker-processes to fork */

+	int queue_length;			/**< Length of the message queue; when it is filled, the server part will

+									 block until workers will finish work on at least one item in the queue */

+	int connect_timeout;		/**< Connect timeout for outbound connections */

+	int transaction_timeout;	/**< Transaction timeout duration */

+	

+	int sessions_hash_size;		/**< Size of the sessions hash table */									 

+	int default_auth_session_timeout; /** The default Authorization Session Timeout to use if none other indicated */ 

+	int max_auth_session_timeout;	  /** The max Authorization Session Timeout limit */ 

+	

+	peer_config *peers;			/**< list of peers */

+	int peers_cnt;				/**< size of the list of peers */

+	

+	acceptor_config *acceptors;	/**< list of acceptors */

+	int acceptors_cnt;			/**< size of the list of acceptors */

+	

+	app_config *applications;	/**< list of supporter applications */

+	int applications_cnt;		/**< size of list of supported applications*/

+

+	int *supported_vendors;		/**< list of supported vendor ids */

+	int supported_vendors_cnt;	/**< size of list of supported vendor ids */

+	

+	routing_table *r_table;		/**< realm routing table */

+} dp_config;

+

+/**

+ * Exported functions. This is the API available for use from other SER modules.

+ * If you require more, please add them here.

+ * <p>

+ * - load_cdp() - find and load the CDiameterPeer function bindings

+ * <p>

+ * - AAACreateRequest() - create a diameter request #AAAMessage

+ * - AAACreateResponse() - create a diameter response #AAAMessage

+ * - AAAFreeMessage() - free up the memory used in a Diameter message

+ * <p>

+ * - AAASendMessage() - asynchronously send a message

+ * - AAASendMessageToPeer() - asynchronously send a message to a forced peer

+ * - AAASendRecvMessage() - synchronously send a message and get the response

+ * - AAASendRecvMessageToPeer() - synchronously send a message and get the response to a forced peer 

+ * <p>

+ * - AAACreateSession() - create a diameter #AAASessionId

+ * - AAADropSession() - drop a diameter #AAASessionId

+ * <p>

+ * - AAACreateTransaction() - create a diameter #AAATransaction

+ * - AAADropTransaction() - drop a diameter #AAATransaction

+ * <p>

+ * - AAACreateAVP() - create an #AAA_AVP

+ * - AAAAddAVPToMessage() - add an #AAA_AVP to a #AAAMessage

+ * - AAAFindMatchingAVP() - find an #AAA_AVP inside a #AAAMessage

+ * - AAAGetNextAVP() - get the next #AAA_AVP from the #AAAMessage

+ * - AAAFreeAVP() - free the memory taken by the #AAA_AVP

+ * - AAAGroupAVPS() - group a #AAA_AVP_LIST of #AAA_AVP into a grouped #AAA_AVP 

+ * - AAAUngroupAVPS() - ungroup a grouped #AAA_AVP into a #AAA_AVP_LIST of #AAA_AVP

+ * - AAAFindMatchingAVPList() - find an #AAA_AVP inside a #AAA_AVP_LIST

+ * - AAAFreeAVPList() - free the memory taken by the all members of #AAA_AVP_LIST

+ * <p>

+ * - AAAAddRequestHandler() - add a #AAARequestHandler_f callback to request being received

+ * - AAAAddResponseHandler() - add a #AAAResponseHandler_f callback to responses being received

+ */

new file mode 100644

@@ -0,0 +1,61 @@

+<?xml version="1.0" encoding="ISO-8859-1"?>

+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"

+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

+<!-- Include general documentation entities -->

+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">

+%docentities;

+]>

+<book>

+  <bookinfo>

+    <title>cdp Module</title>

+

+    <productname class="trade">&kamailioname;</productname>

+

+    <authorgroup>

+      <author>

+        <firstname>Jason Penton</firstname>

+

+        <surname/>

+

+        <affiliation>

+          <orgname>Smile Communications</orgname>

+        </affiliation>

+

+        <address>

+			<email>jason.penton@smilecoms.com</email>

+		</address>

+      </author>

+

+      <editor>

+        <firstname>Richard</firstname>

+

+        <surname>Good</surname>

+        

+	<affiliation>

+          <orgname>Smile Communications</orgname>

+        </affiliation>

+

+        <address>

+			<email>richard.good@smilecoms.com</email>

+		</address>

+      </editor>

+    </authorgroup>

+

+    <copyright>

+      <year>2012</year>

+

+      <holder>Smile Communications</holder>

+    </copyright>

+  </bookinfo>

+

+  <toc/>

+

+  <xi:include href="usrloc_pcscf_admin.xml"

+              xmlns:xi="http://www.w3.org/2001/XInclude"/>

+

+  <xi:include href="usrloc_pcscf_devel.xml"

+              xmlns:xi="http://www.w3.org/2001/XInclude"/>

+

+  <xi:include href="usrloc_pcscf_faq.xml"

+              xmlns:xi="http://www.w3.org/2001/XInclude"/>

+</book>

new file mode 100644

@@ -0,0 +1,153 @@

+<?xml version="1.0" encoding="ISO-8859-1"?>

+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"

+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

+<!-- Include general documentation entities -->

+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">

+%docentities;

+]>

+<!-- Module User's Guide -->

+<chapter>

+  <title>&adminguide;</title>

+

+  <section>

+    <title>Overview</title>

+

+    <para>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. Alot of the design has been borrowed from the std. usrloc module.

+    For example. An IMS contact, in PCSCF, needs things like:</para>

+

+    <para><itemizedlist>

+        <listitem>

+          <para>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'</para>

+        </listitem>

+

+        <listitem>

+          <para>IPSEC Security Assocation for secure signalling between UE and

+          PCSCF (first point of contact)</para>

+        </listitem>

+

+        <listitem>

+          <para>IMPU, each contact can have a number of associated public

+          identities (IMPU).</para>

+        </listitem>

+      </itemizedlist></para>

+  </section>

+

+  <section>

+    <title>Dependencies</title>

+

+    <section>

+      <title>&kamailio; Modules</title>

+

+      <para>The following modules must be loaded before this module:

+      <itemizedlist>

+          <listitem>

+            <para><emphasis>None</emphasis>.</para>

+          </listitem>

+        </itemizedlist></para>

+    </section>

+

+    <section>

+      <title>External Libraries or Applications</title>

+

+      <para>The following libraries or applications must be installed before

+      running &kamailio; with this module loaded: <itemizedlist>

+          <listitem>

+            <para><emphasis>None</emphasis>.</para>

+          </listitem>

+        </itemizedlist></para>

+    </section>

+  </section>

+

+  <section>

+    <title>Parameters</title>

+

+    <section>

+      <title>hash_size (int)</title>

+

+      <para>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. </para>

+

+      <para><emphasis> Default value is 9. </emphasis></para>

+

+      <example>

+        <title>Set <varname>hash_size</varname> parameter</title>

+

+        <programlisting format="linespecific">...

+modparam("usrloc_pcscf", "hash_size", 10)

+...

+</programlisting>

+      </example>

+    </section>

+

+    <section>

+      <title>timer_interval (int)</title>

+

+      <para>Number of seconds between two timer runs. The module uses timer to

+      delete expired contacts. </para>

+

+      <para><emphasis> Default value is 60. </emphasis></para>

+

+      <example>

+        <title>Set timer_interval parameter</title>

+

+        <programlisting format="linespecific">...

+modparam("usrloc_pcscf", "timer_interval", 30)

+...

+</programlisting>

+      </example>

+    </section>

+  </section>

+

+  <section>

+    <title>Functions</title>

+

+    <section>

+      <para>There are no exported functions that could be used in scripts.

+      </para>

+    </section>

+  </section>

+

+  <section>

+    <title>RPC Commands</title>

+

+    <para>exported RPC commands.</para>

+

+    <section>

+      <title>ulpcscf.status</title>

+

+      <para>Status of pcscf_usrloc, AORs, max slots, etc.</para>

+    </section>

+  </section>

+

+  <section>

+    <title>Statistics</title>

+

+    <para>Exported statistics are listed in the next sections. </para>

+

+    <section>

+      <title>registered contacts</title>

+

+      <para>Number of AOR contacts in registered state - cannot be

+      reset.</para>

+    </section>

+

+    <section>

+      <title>impus</title>

+

+      <para>Number of IMPUs - cannot be reset.</para>

+    </section>

+

+    <section>

+      <title>expired contacts</title>

+

+      <para>Number of expired contacts - can be reset.</para>

+    </section>

+  </section>

+</chapter>

new file mode 100644

@@ -0,0 +1,682 @@

+<?xml version="1.0" encoding="ISO-8859-1"?>

+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"

+"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

+<!-- Include general documentation entities -->

+<!ENTITY % docentities SYSTEM "../../../docbook/entities.xml">

+%docentities;

+]>

+<!-- Module Developer's Guide -->

+<chapter>

+  <title>&develguide;</title>

+

+  <section>

+    <title>Available Functions</title>

+

+    <section>

+      <title><function moreinfo="none">load_cdp(struct cdp_binds

+      *cdpb)</function></title>

+

+      <para>Find and load the CDiameterPeer function bindings</para>

+

+      <para>Meaning of the parameters is as follows:</para>

+

+      <itemizedlist>

+        <listitem>

+          <para><emphasis>struct cdp_binds *cdpb</emphasis> - structure

+          holding function pointers</para>

+        </listitem>

+      </itemizedlist>

+    </section>

+

+    <section>

+      <title><function moreinfo="none">AAACreateRequest(AAAApplicationId

+      app_id, AAACommandCode command_code, AAAMsgFlag flags, AAASession

+      *session)</function></title>

+

+      <para>Create a Diameter request</para>

+

+      <para>Meaning of the parameters is as follows:</para>

+

+      <itemizedlist>

+        <listitem>

+          <para><emphasis>AAAApplicationId app_id</emphasis> - structure

+          holding function pointers</para>

+        </listitem>

+

+        <listitem>

+          <para>AAACommandCode command_code - command code for the

+          message</para>

+        </listitem>

+

+        <listitem>

+          <para>AAAMsgFlag flags - flags to be set</para>

+        </listitem>

+

+        <listitem>

+          <para>AAASession *session - session id to be set</para>

+        </listitem>

+      </itemizedlist>

+    </section>

+