Преглед на файлове

modules_k/rr: Updates to rr module documentation for outbound

Peter Dunkley преди 12 години
родител
ревизия
b0ee720bec
променени са 2 файла, в които са добавени 25 реда и са изтрити 0 реда
  1. 5 0
      modules_k/rr/README
  2. 20 0
      modules_k/rr/doc/rr_admin.xml

+ 5 - 0
modules_k/rr/README

@@ -321,6 +321,11 @@ modparam("rr", "enable_socket_mismatch_warning", 0)
    details (grep for “route set” is a good starting point in this
    comprehensive RFC).
 
+   Return codes:
+     * 1 - route calculation has been successful
+     * -1 - route calculation has been unsuccessful
+     * -2 - outbound flow-token shows evidence of tampering
+
    This function can be used from REQUEST_ROUTE.
 
    Example 1.7. loose_route usage

+ 20 - 0
modules_k/rr/doc/rr_admin.xml

@@ -292,6 +292,26 @@ modparam("rr", "enable_socket_mismatch_warning", 0)
 		this comprehensive RFC).
 		</para>
 		<para>
+		Return codes:
+		</para>
+		<itemizedlist>
+		<listitem>
+			<para>
+			<emphasis>1</emphasis> - route calculation has been successful
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>-1</emphasis> - route calculation has been unsuccessful
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>-2</emphasis> - outbound flow-token shows evidence of tampering
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
 		This function can be used from REQUEST_ROUTE.
 		</para>
 		<example>