浏览代码

modules/tm: Added branch_failure event route to tm documentation

Hugh Waite 12 年之前
父节点
当前提交
b38d9c9320
共有 3 个文件被更改,包括 378 次插入336 次删除
  1. 343 336
      modules/tm/README
  2. 34 0
      modules/tm/doc/event_routes.xml
  3. 1 0
      modules/tm/doc/tm.xml

文件差异内容过多而无法显示
+ 343 - 336
modules/tm/README


+ 34 - 0
modules/tm/doc/event_routes.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 
+   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<section id="tm.event_routes" xmlns:xi="http://www.w3.org/2001/XInclude">
+    <sectioninfo>
+    </sectioninfo>
+
+    <title>Event Routes</title>
+
+    <section id="tm.e.branch_failure">
+	<title>
+	    <function moreinfo="none">event_route[tm:branch_failure]</function>
+	</title>
+	<para>
+            When defined, this event route will be run when a failure response is received.
+            This allows handling failures on individual branches, for example, retrying an alternative outbound flow.
+	</para>
+        <para>
+            This event_route uses the BRANCH_FAILURE_ROUTE route type.
+        </para>
+	<example>
+	    <title><function>event_route[tm:branch_failure]</function> usage</title>
+	    <programlisting>
+...
+event_route[tm:branch_failure] {
+    xlog("L_INFO", "Received $T_reply_code to $rm message\n");
+}
+...
+	    </programlisting>
+	</example>
+    </section>
+
+</section>

+ 1 - 0
modules/tm/doc/tm.xml

@@ -348,5 +348,6 @@ failure_route["serial"]
     <xi:include href="params.xml"/>
     <xi:include href="functions.xml"/>
     <xi:include href="api.xml"/>
+    <xi:include href="event_routes.xml"/>
 
 </section>

部分文件因为文件数量过多而无法显示