Browse Source

nat_traversal Add comment about lacking IPv6 support

Olle E. Johansson 10 years ago
parent
commit
cc8ff059d3
2 changed files with 13 additions and 9 deletions
  1. 11 9
      modules/nat_traversal/README
  2. 2 0
      modules/nat_traversal/doc/nat_traversal_admin.xml

+ 11 - 9
modules/nat_traversal/README

@@ -10,7 +10,7 @@ Dan Pascu
 
    <[email protected]>
 
-   Copyright © 2008 Dan Pascu
+   Copyright © 2008 Dan Pascu
      __________________________________________________________________
 
    Table of Contents
@@ -139,6 +139,8 @@ Chapter 1. Admin Guide
    SIP proxies may be involved in handling registration and routing and
    where the incoming and outgoing paths may not necessarily be the same,
    or where the routing path may even change between consecutive dialogs.
+   The nat_traversal functionality is built primarily for IPv4 NAT
+   handling and hasn't been adapted to support IPv6 session keepalives.
 
 2. Keepalive functionality
 
@@ -405,7 +407,7 @@ Chapter 1. Admin Guide
    each endpoint will receive exactly one keepalive message. A negative
    value or zero will disable the keepalive functionality.
 
-   Default value is “60�.
+   Default value is "60".
 
    Example 1.1. Setting the keepalive_interval parameter
 ...
@@ -418,7 +420,7 @@ modparam("nat_traversal", "keepalive_interval", 90)
    for this purpose are NOTIFY and OPTIONS. NOTIFY generates smaller
    replies from user agents, but they are almost entirely negative
    replies. Apparently almost none of the user agents understand that the
-   purpose of the NOTIFY with a “keep-alive� event is to keep NAT open,
+   purpose of the NOTIFY with a "keep-alive" event is to keep NAT open,
    even though many user agents send such NOTIFY requests themselves.
    However this does not affect the result at all, since the purpose is to
    trigger a response from the user agent behind NAT, positive or negative
@@ -433,7 +435,7 @@ modparam("nat_traversal", "keepalive_interval", 90)
    times bigger than negative replies or replies to NOTIFY requests. For
    this reason the default value for the used method is NOTIFY.
 
-   Default value is “NOTIFY�.
+   Default value is "NOTIFY".
 
    Example 1.2. Setting the keepalive_method parameter
 ...
@@ -448,7 +450,7 @@ modparam("nat_traversal", "keepalive_method", "OPTIONS")
    keepalive message, which is the same interface on which the request
    that triggered keepalive functionality arrived.
 
-   Default value is “sip:keepalive@proxy_ip� with proxy_ip being the
+   Default value is "sip:keepalive@proxy_ip" with proxy_ip being the
    actual IP of the outgoing interface.
 
    Example 1.3. Setting the keepalive_from parameter
@@ -487,7 +489,7 @@ MyHeader: some_value\r\n")
    case it will store it in the Kamailio working directory, or an absolute
    path.
 
-   Default value is undefined “keepalive_state�.
+   Default value is undefined "keepalive_state".
 
    Example 1.5. Setting the keepalive_state_file parameter
 ...
@@ -501,7 +503,7 @@ tate")
    5.2. fix_contact()
    5.3. nat_keepalive()
 
-5.1.  client_nat_test(type)
+5.1. client_nat_test(type)
 
    Check if the client is behind NAT. What tests are performed is
    specified by the type parameter which is an integer given by the sum of
@@ -531,7 +533,7 @@ if (client_nat_test("3")) {
 }
 ...
 
-5.2.  fix_contact()
+5.2. fix_contact()
 
    Will replace the IP and port in the Contact header with the IP and port
    the SIP message was received from. Usually called after a succesful
@@ -547,7 +549,7 @@ if (client_nat_test("3")) {
 }
 ...
 
-5.3.  nat_keepalive()
+5.3. nat_keepalive()
 
    Trigger keepalive functionality for the source address of the request.
    When called it only sets some internal flags, which will trigger later

+ 2 - 0
modules/nat_traversal/doc/nat_traversal_admin.xml

@@ -29,6 +29,8 @@
       SIP proxies may be involved in handling registration and routing and
       where the incoming and outgoing paths may not necessarily be the same,
       or where the routing path may even change between consecutive dialogs.
+      The nat_traversal functionality is built primarily for IPv4 NAT handling
+      and hasn't been adapted to support IPv6 session keepalives.
     </para>
   </section>