Helix SwarmHelix Swarm
Loading...

ErrorHandling.html

  • //
  • guest/
  • doug_scheirer/
  • helix-web-services/
  • main/
  • build/
  • doc/
  • helix_web_services/
  • HelixWebServices/
  • ErrorHandling.html #10
  • View
  • Commits
  • Open Download .zip Download (10 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7.   Module: HelixWebServices::ErrorHandling
  8.   
  9.     &mdash; Documentation by YARD 0.8.7.6
  10.   
  11. </title>
  12.  
  13.   <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
  14.  
  15.   <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
  16.  
  17. <script type="text/javascript" charset="utf-8">
  18.   hasFrames = window.top.frames.main ? true : false;
  19.   relpath = '../';
  20.   framesUrl = "../frames.html#!HelixWebServices/ErrorHandling.html";
  21. </script>
  22.  
  23.  
  24.   <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
  25.  
  26.   <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
  27.  
  28.  
  29.   </head>
  30.   <body>
  31.     <div id="header">
  32.       <div id="menu">
  33.   
  34.     <a href="../_index.html">Index (E)</a> &raquo;
  35.     <span class='title'><span class='object_link'><a href="../HelixWebServices.html" title="HelixWebServices (module)">HelixWebServices</a></span></span>
  36.      &raquo; 
  37.     <span class="title">ErrorHandling</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="../class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="../method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="../file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Module: HelixWebServices::ErrorHandling
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.   
  75.     
  76.   
  77.     
  78.   
  79.   
  80.   
  81.     <dt class="r1 last">Defined in:</dt>
  82.     <dd class="r1 last">lib/helix_web_services.rb</dd>
  83.   
  84. </dl>
  85. <div class="clear"></div>
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.   
  95.     <h2>
  96.       Class Method Summary
  97.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  98.     </h2>
  99.  
  100.     <ul class="summary">
  101.       
  102.         <li class="public ">
  103.   <span class="summary_signature">
  104.     
  105.       <a href="#registered-class_method" title="registered (class method)">+ (Object) <strong>registered</strong>(app) </a>
  106.     
  107.  
  108.     
  109.   </span>
  110.   
  111.   
  112.   
  113.   
  114.   
  115.   
  116.   
  117.  
  118.   
  119.     <span class="summary_desc"><div class='inline'></div></span>
  120.   
  121. </li>
  122.  
  123.       
  124.     </ul>
  125.   
  126.  
  127.  
  128.  
  129.   <div id="class_method_details" class="method_details_list">
  130.     <h2>Class Method Details</h2>
  131.  
  132.     
  133.       <div class="method_details first">
  134.   <h3 class="signature first" id="registered-class_method">
  135.   
  136.     + (<tt>Object</tt>) <strong>registered</strong>(app) 
  137.   
  138.  
  139.   
  140.  
  141.   
  142. </h3><table class="source_code">
  143.   <tr>
  144.     <td>
  145.       <pre class="lines">
  146.  
  147.  
  148. 19
  149. 20
  150. 21
  151. 22
  152. 23
  153. 24
  154. 25
  155. 26
  156. 27
  157. 28
  158. 29
  159. 30
  160. 31
  161. 32
  162. 33
  163. 34
  164. 35
  165. 36
  166. 37
  167. 38
  168. 39
  169. 40
  170. 41
  171. 42
  172. 43
  173. 44
  174. 45
  175. 46
  176. 47
  177. 48
  178. 49
  179. 50
  180. 51
  181. 52
  182. 53
  183. 54
  184. 55
  185. 56
  186. 57
  187. 58
  188. 59
  189. 60
  190. 61
  191. 62
  192. 63
  193. 64
  194. 65
  195. 66
  196. 67
  197. 68
  198. 69</pre>
  199.     </td>
  200.     <td>
  201.       <pre class="code"><span class="info file"># File 'lib/helix_web_services.rb', line 19</span>
  202.  
  203. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_registered'>registered</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
  204.   <span class='comment'># Always invoke our error handlers.
  205. </span>  <span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span> <span class='symbol'>:raise_errors</span> <span class='op'>=&gt;</span> <span class='kw'>false</span>
  206.   <span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span> <span class='symbol'>:show_exceptions</span> <span class='op'>=&gt;</span> <span class='kw'>false</span>
  207.   <span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span> <span class='symbol'>:dump_errors</span> <span class='op'>=&gt;</span> <span class='kw'>true</span>
  208.  
  209.   <span class='id identifier rubyid_app'>app</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_err'>err</span><span class='op'>|</span>
  210.     <span class='id identifier rubyid_err'>err</span> <span class='op'>=</span> <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sinatra.error</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  211.  
  212.     <span class='kw'>if</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>P4Exception</span><span class='rparen'>)</span>
  213.       <span class='comment'># Can happen when we&#39;re not passing a block to
  214. </span>      <span class='comment'># open_p4. Convert to a P4WebAPI error. This is not ideal
  215. </span>      <span class='comment'># as it always uses the same code, but then we have no idea
  216. </span>      <span class='comment'># what actually happened here.
  217. </span>
  218.       <span class='id identifier rubyid_err'>err</span> <span class='op'>=</span> <span class='const'>P4Error</span><span class='period'>.</span><span class='id identifier rubyid_default_error'>default_error</span><span class='lparen'>(</span><span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
  219.  
  220.       <span class='comment'># Fall through...
  221. </span>    <span class='kw'>end</span>
  222.  
  223.     <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='kw'>nil</span>
  224.  
  225.     <span class='kw'>if</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>P4Error</span><span class='rparen'>)</span>
  226.       <span class='kw'>if</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_message_code'>message_code</span> <span class='op'>==</span> <span class='int'>7480</span> <span class='op'>||</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_message_code'>message_code</span> <span class='op'>==</span> <span class='int'>7189</span>
  227.         <span class='id identifier rubyid_halt'>halt</span> <span class='int'>401</span><span class='comma'>,</span> <span class='lbrace'>{</span>
  228.                     <span class='label'>MessageCode:</span> <span class='int'>0</span><span class='comma'>,</span>
  229.                     <span class='label'>MessageSeverity:</span> <span class='int'>4</span><span class='comma'>,</span>
  230.                     <span class='label'>MessageText:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Resource not found</span><span class='tstring_end'>&#39;</span></span>
  231.                 <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
  232.       <span class='kw'>else</span>
  233.         <span class='id identifier rubyid_code'>code</span> <span class='op'>=</span> <span class='int'>500</span>
  234.         <span class='id identifier rubyid_code'>code</span> <span class='op'>=</span> <span class='int'>400</span> <span class='kw'>if</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_user_error?'>user_error?</span>
  235.         <span class='id identifier rubyid_halt'>halt</span> <span class='id identifier rubyid_code'>code</span><span class='comma'>,</span> <span class='lbrace'>{</span>
  236.                      <span class='label'>MessageCode:</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_message_code'>message_code</span><span class='comma'>,</span>
  237.                      <span class='label'>MessageSeverity:</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_message_severity'>message_severity</span><span class='comma'>,</span>
  238.                      <span class='label'>MessageText:</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_message_text'>message_text</span>
  239.                  <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
  240.       <span class='kw'>end</span>
  241.     <span class='kw'>end</span>
  242.  
  243.     <span class='kw'>if</span> <span class='id identifier rubyid_body'>body</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
  244.       <span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
  245.           <span class='label'>MessageCode:</span> <span class='int'>15_361</span><span class='comma'>,</span>
  246.           <span class='label'>MessageSeverity:</span> <span class='const'>P4</span><span class='op'>::</span><span class='const'>E_FATAL</span><span class='comma'>,</span>
  247.           <span class='label'>MessageText:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unknown server issue</span><span class='tstring_end'>&#39;</span></span>
  248.       <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span>
  249.     <span class='kw'>end</span>
  250.  
  251.     <span class='id identifier rubyid_halt'>halt</span> <span class='int'>500</span><span class='comma'>,</span> <span class='id identifier rubyid_body'>body</span>
  252.   <span class='kw'>end</span>
  253. <span class='kw'>end</span></pre>
  254.     </td>
  255.   </tr>
  256. </table>
  257. </div>
  258.     
  259.   </div>
  260.  
  261. </div>
  262.  
  263.     <div id="footer">
  264.   Generated on Mon Oct 12 22:20:50 2015 by
  265.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  266.   0.8.7.6 (ruby-2.2.3).
  267. </div>
  268.  
  269.   </body>
  270. </html>
# Change User Description Committed
#10 16275 Doug Scheirer Merge from main 9 years ago
#9 16196 Doug Scheirer Merge from main 9 years ago
#8 16148 Doug Scheirer Merge from main 9 years ago
#7 16114 Doug Scheirer Merge from main 9 years ago
#6 16079 Doug Scheirer Merge from main 9 years ago
#5 16014 Doug Scheirer Merge down from main 9 years ago
#4 15884 Doug Scheirer Merge from main 9 years ago
#3 15868 Doug Scheirer Merge from main 9 years ago
#2 15845 Doug Scheirer Integ from main 9 years ago
#1 15715 Doug Scheirer merge changes from main 10 years ago
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services/HelixWebServices/ErrorHandling.html
#3 15708 tjuricek HWS/NOARCH/2015.1.main/201509140120 10 years ago
#2 15699 tjuricek HWS/NOARCH/2015.1.main/201509111845 10 years ago
#1 15690 tjuricek HWS/NOARCH/2015.1.main/201509110141 10 years ago