git:master: modules/sipt: updated README - sr-dev

5 Apr 2013

Module: sip-router
Branch: master
Commit: d992e4dc8742807f71645f385d68d60b90746fb3
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=d992e4dc...
Author: Torrey Searle tsearle@gmail.com
Committer: Torrey Searle tsearle@gmail.com
Date:   Fri Apr  5 18:43:06 2013 +0200
modules/sipt: updated README
---
modules/sipt/README |  117 +++++++++++++-------------------------------------
 1 files changed, 31 insertions(+), 86 deletions(-)

diff --git a/modules/sipt/README b/modules/sipt/README
index f655523..75ea181 100644
--- a/modules/sipt/README
+++ b/modules/sipt/README
@@ -1,86 +1,31 @@
-sipt Module
-
-Torrey Searle
-
-   Voxbone SA
-   torrey@voxbone.com
-
-   Copyright © 2013 Voxbone SA
-     __________________________________________________________________
-
-   Table of Contents
-
-   1. Admin Guide
-
-        1. Overview
-        2. Dependencies
-        3. Functions
-
-              3.1. sipt_destination(destination, hops, nai)
-              3.2. sipt_get_hop_counter()
-
-   List of Examples
-
-   1.1. sipt_destination(destination, hops, nai) usage
-   1.2. sipt_get_hop_counter() usage
-
-Chapter 1. Admin Guide
-
-   Table of Contents
-
-   1. Overview
-   2. Dependencies
-   3. Functions
-
-        3.1. sipt_destination(destination, hops, nai)
-        3.2. sipt_get_hop_counter()
-
-1. Overview
-
-   Module for updating ISUP encapuslated in SIP (SIP-T/SIP-I)
-
-   The sipt module can be used to update various ss7 headers contained
-   inside a message.
-
-2. Dependencies
-
-   The module depends on the following modules (in the other words the
-   listed modules must be loaded before this module):
-     * none
-
-3. Functions
-
-   3.1. sipt_destination(destination, hops, nai)
-   3.2. sipt_get_hop_counter()
-
-3.1. sipt_destination(destination, hops, nai)
-
-   updates the IAM in the body if it exists, setting the called party
-   number to “destination” with the nature address specified in “nai” and
-   decrementing the hop counter value if present. If the hop counter
-   header is missing it will be added with the value of “hops”.
-
-   Example 1.1. sipt_destination(destination, hops, nai) usage
-...
-# update the destination number to our current request uri,
-# setting nature of address to international
-$rU = "19495551234";
-sipt_destination($rU, 31, 4);
-...
-
-3.2. sipt_get_hop_counter()
-
-   Returns the value of the Hop Counter for the IAM message if it exists.
-   Returns -1 if there isn't a hop counter.
-
-   Example 1.2. sipt_get_hop_counter() usage
-...
-# get the hop counter and update the Max-Forwards header if it exists
-$avp(s:hop) = sipt_get_hop_counter();
-if($avp(s:hop) > 0)
-{
-        remove_hf("Max-Forwards");
-        append_hf("Max-Forwards: $avp(s:hop)\r\n");
-}
-
-...
+<?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 xmlns:xi="http://www.w3.org/2001/XInclude">
+	<bookinfo>
+	<title>sipt Module</title>
+	<authorgroup>
+		<author>
+		<firstname>Torrey</firstname>
+		<surname>Searle</surname>
+		<affiliation><orgname>Voxbone SA</orgname></affiliation>
+		<email>torrey@voxbone.com</email>
+		</author>
+	</authorgroup>
+	<copyright>
+		<year>2013</year>
+		<holder>Voxbone SA</holder>
+	</copyright>
+	</bookinfo>
+	<toc></toc>
+
+	<xi:include href="sipt_admin.xml"/>
+
+</book>

    