From: Galen Charlton <gmc@esilibrary.com>
Date: Tue, 1 Nov 2016 21:20:49 +0000 (-0400)
Subject: LP#1631522: dev doc now describes ->dispatch
X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=31a0bfea9911f24f563d70bfdea6ba7759071842;p=working%2FOpenSRF.git

LP#1631522: dev doc now describes ->dispatch

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
---

diff --git a/doc/Application-HOWTO.txt b/doc/Application-HOWTO.txt
index 41deae1..36e508d 100644
--- a/doc/Application-HOWTO.txt
+++ b/doc/Application-HOWTO.txt
@@ -22,8 +22,12 @@ sends to the client:
 
   my ($subresult) = $meth->run( @params )
                    # runs the subrequest method and returns the array of
-		   # results
+                   # results
 
+  return $meth->dispatch( @params )
+                   # like ->run, but control of the session is passed to
+                   # to the delegated method, whose responses are sent
+                   # directly to the original client
 
 The method is also handed an OpenSRF::AppRequest object that has been
 constructed for the client request that generated the call to the method.