PageRenderTime 47ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/gems/doc/httpclient-2.2.0.2/rdoc/HTTPClient/Timeout.html

http://github.com/shouldly/shouldly
HTML | 291 lines | 164 code | 120 blank | 7 comment | 0 complexity | 520bd0c022b76dd3942386029b325f78 MD5 | raw file
Possible License(s): GPL-2.0, BSD-3-Clause 
    

  1. <?xml version="1.0" encoding="utf-8"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    3. 

  3. 	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6. 	<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
    7. 

  7. 

  8. 	<title>Module: HTTPClient::Timeout</title>
    9. 

  9. 

  10. 	<link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
    11. 

  11. 

  12. 	<script src="../js/jquery.js" type="text/javascript"
    13. 

  13. 		charset="utf-8"></script>
    14. 

  14. 	<script src="../js/thickbox-compressed.js" type="text/javascript"
    15. 

  15. 		charset="utf-8"></script>
    16. 

  16. 	<script src="../js/quicksearch.js" type="text/javascript"
    17. 

  17. 		charset="utf-8"></script>
    18. 

  18. 	<script src="../js/darkfish.js" type="text/javascript"
    19. 

  19. 		charset="utf-8"></script>
    20. 

  20. 

  21. </head>
    22. 

  22. <body class="module">
    23. 

  23. 

  24. 	<div id="metadata">
    25. 

  25. 		<div id="home-metadata">
    26. 

  26. 			<div id="home-section" class="section">
    27. 

  27.         <h3 class="section-header">
    28. 

  28.           <a href="../index.html">Home</a>
    29. 

  29.           <a href="../index.html#classes">Classes</a>
    30. 

  30.           <a href="../index.html#methods">Methods</a>
    31. 

  31.         </h3>
    32. 

  32. 			</div>
    33. 

  33. 		</div>
    34. 

  34. 

  35. 		<div id="file-metadata">
    36. 

  36. 			<div id="file-list-section" class="section">
    37. 

  37. 				<h3 class="section-header">In Files</h3>
    38. 

  38. 				<div class="section-body">
    39. 

  39. 					<ul>
    40. 

  40. 					
    41. 

  41. 						<li><a href="../lib/httpclient/timeout_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
    42. 

  42. 							class="thickbox" title="lib/httpclient/timeout.rb">lib/httpclient/timeout.rb</a></li>
    43. 

  43. 					
    44. 

  44. 					</ul>
    45. 

  45. 				</div>
    46. 

  46. 			</div>
    47. 

  47. 

  48. 			
    49. 

  49. 		</div>
    50. 

  50. 

  51. 		<div id="class-metadata">
    52. 

  52. 

  53. 			<!-- Parent Class -->
    54. 

  54. 			
    55. 

  55. 

  56. 			<!-- Namespace Contents -->
    57. 

  57. 			
    58. 

  58. 

  59. 			<!-- Method Quickref -->
    60. 

  60. 			
    61. 

  61. 			<div id="method-list-section" class="section">
    62. 

  62. 				<h3 class="section-header">Methods</h3>
    63. 

  63. 				<ul class="link-list">
    64. 

  64. 					
    65. 

  65. 					<li><a href="#method-i-timeout">#timeout</a></li>
    66. 

  66. 					
    67. 

  67. 				</ul>
    68. 

  68. 			</div>
    69. 

  69. 			
    70. 

  70. 

  71. 			<!-- Included Modules -->
    72. 

  72. 			
    73. 

  73. 		</div>
    74. 

  74. 

  75. 		<div id="project-metadata">
    76. 

  76. 			
    77. 

  77. 			
    78. 

  78. 

  79. 			<div id="classindex-section" class="section project-section">
    80. 

  80. 				<h3 class="section-header">Class Index
    81. 

  81. 					<span class="search-toggle"><img src="../images/find.png"
    82. 

  82. 						height="16" width="16" alt="[+]"
    83. 

  83. 						title="show/hide quicksearch" /></span></h3>
    84. 

  84. 				<form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
    85. 

  85. 				<fieldset>
    86. 

  86. 					<legend>Quicksearch</legend>
    87. 

  87. 					<input type="text" name="quicksearch" value=""
    88. 

  88. 						class="quicksearch-field" />
    89. 

  89. 				</fieldset>
    90. 

  90. 				</form>
    91. 

  91. 

  92. 				<ul class="link-list">
    93. 

  93. 				
    94. 

  94. 					<li><a href="../HTTPClient.html">HTTPClient</a></li>
    95. 

  95. 				
    96. 

  96. 					<li><a href="../HTTPClient/AuthFilterBase.html">HTTPClient::AuthFilterBase</a></li>
    97. 

  97. 				
    98. 

  98. 					<li><a href="../HTTPClient/BadResponseError.html">HTTPClient::BadResponseError</a></li>
    99. 

  99. 				
    100. 

  100. 					<li><a href="../HTTPClient/BadResponseError.html">HTTPClient::BadResponseError</a></li>
    101. 

  101. 				
    102. 

  102. 					<li><a href="../HTTPClient/BasicAuth.html">HTTPClient::BasicAuth</a></li>
    103. 

  103. 				
    104. 

  104. 					<li><a href="../HTTPClient/ConfigurationError.html">HTTPClient::ConfigurationError</a></li>
    105. 

  105. 				
    106. 

  106. 					<li><a href="../HTTPClient/ConnectTimeoutError.html">HTTPClient::ConnectTimeoutError</a></li>
    107. 

  107. 				
    108. 

  108. 					<li><a href="../HTTPClient/Connection.html">HTTPClient::Connection</a></li>
    109. 

  109. 				
    110. 

  110. 					<li><a href="../HTTPClient/DebugSocket.html">HTTPClient::DebugSocket</a></li>
    111. 

  111. 				
    112. 

  112. 					<li><a href="../HTTPClient/DigestAuth.html">HTTPClient::DigestAuth</a></li>
    113. 

  113. 				
    114. 

  114. 					<li><a href="../HTTPClient/LoopBackSocket.html">HTTPClient::LoopBackSocket</a></li>
    115. 

  115. 				
    116. 

  116. 					<li><a href="../HTTPClient/NegotiateAuth.html">HTTPClient::NegotiateAuth</a></li>
    117. 

  117. 				
    118. 

  118. 					<li><a href="../HTTPClient/OAuth.html">HTTPClient::OAuth</a></li>
    119. 

  119. 				
    120. 

  120. 					<li><a href="../HTTPClient/OAuth/Config.html">HTTPClient::OAuth::Config</a></li>
    121. 

  121. 				
    122. 

  122. 					<li><a href="../HTTPClient/ProxyAuth.html">HTTPClient::ProxyAuth</a></li>
    123. 

  123. 				
    124. 

  124. 					<li><a href="../HTTPClient/ReceiveTimeoutError.html">HTTPClient::ReceiveTimeoutError</a></li>
    125. 

  125. 				
    126. 

  126. 					<li><a href="../HTTPClient/SSLConfig.html">HTTPClient::SSLConfig</a></li>
    127. 

  127. 				
    128. 

  128. 					<li><a href="../HTTPClient/SSLSocketWrap.html">HTTPClient::SSLSocketWrap</a></li>
    129. 

  129. 				
    130. 

  130. 					<li><a href="../HTTPClient/SSPINegotiateAuth.html">HTTPClient::SSPINegotiateAuth</a></li>
    131. 

  131. 				
    132. 

  132. 					<li><a href="../HTTPClient/SendTimeoutError.html">HTTPClient::SendTimeoutError</a></li>
    133. 

  133. 				
    134. 

  134. 					<li><a href="../HTTPClient/Session.html">HTTPClient::Session</a></li>
    135. 

  135. 				
    136. 

  136. 					<li><a href="../HTTPClient/SessionManager.html">HTTPClient::SessionManager</a></li>
    137. 

  137. 				
    138. 

  138. 					<li><a href="../HTTPClient/Site.html">HTTPClient::Site</a></li>
    139. 

  139. 				
    140. 

  140. 					<li><a href="../HTTPClient/SocketWrap.html">HTTPClient::SocketWrap</a></li>
    141. 

  141. 				
    142. 

  142. 					<li><a href="../HTTPClient/Timeout.html">HTTPClient::Timeout</a></li>
    143. 

  143. 				
    144. 

  144. 					<li><a href="../HTTPClient/TimeoutError.html">HTTPClient::TimeoutError</a></li>
    145. 

  145. 				
    146. 

  146. 					<li><a href="../HTTPClient/TimeoutScheduler.html">HTTPClient::TimeoutScheduler</a></li>
    147. 

  147. 				
    148. 

  148. 					<li><a href="../HTTPClient/TimeoutScheduler/Period.html">HTTPClient::TimeoutScheduler::Period</a></li>
    149. 

  149. 				
    150. 

  150. 					<li><a href="../HTTPClient/Util.html">HTTPClient::Util</a></li>
    151. 

  151. 				
    152. 

  152. 					<li><a href="../HTTPClient/WWWAuth.html">HTTPClient::WWWAuth</a></li>
    153. 

  153. 				
    154. 

  154. 					<li><a href="../HTTPAccess2.html">HTTPAccess2</a></li>
    155. 

  155. 				
    156. 

  156. 					<li><a href="../HTTPAccess2/Client.html">HTTPAccess2::Client</a></li>
    157. 

  157. 				
    158. 

  158. 					<li><a href="../HTTPAccess2/Client/RetryableResponse.html">HTTPAccess2::Client::RetryableResponse</a></li>
    159. 

  159. 				
    160. 

  160. 					<li><a href="../HTTPAccess2/Session.html">HTTPAccess2::Session</a></li>
    161. 

  161. 				
    162. 

  162. 					<li><a href="../HTTPAccess2/Session/BadResponse.html">HTTPAccess2::Session::BadResponse</a></li>
    163. 

  163. 				
    164. 

  164. 					<li><a href="../HTTPAccess2/Session/Error.html">HTTPAccess2::Session::Error</a></li>
    165. 

  165. 				
    166. 

  166. 					<li><a href="../HTTPAccess2/Session/InvalidState.html">HTTPAccess2::Session::InvalidState</a></li>
    167. 

  167. 				
    168. 

  168. 					<li><a href="../HTTPAccess2/Session/KeepAliveDisconnected.html">HTTPAccess2::Session::KeepAliveDisconnected</a></li>
    169. 

  169. 				
    170. 

  170. 					<li><a href="../WebAgent.html">WebAgent</a></li>
    171. 

  171. 				
    172. 

  172. 					<li><a href="../WebAgent/Cookie.html">WebAgent::Cookie</a></li>
    173. 

  173. 				
    174. 

  174. 					<li><a href="../WebAgent/CookieManager.html">WebAgent::CookieManager</a></li>
    175. 

  175. 				
    176. 

  176. 					<li><a href="../WebAgent/CookieManager/Error.html">WebAgent::CookieManager::Error</a></li>
    177. 

  177. 				
    178. 

  178. 					<li><a href="../WebAgent/CookieManager/ErrorOverrideOK.html">WebAgent::CookieManager::ErrorOverrideOK</a></li>
    179. 

  179. 				
    180. 

  180. 					<li><a href="../WebAgent/CookieManager/SpecialError.html">WebAgent::CookieManager::SpecialError</a></li>
    181. 

  181. 				
    182. 

  182. 					<li><a href="../WebAgent/CookieUtils.html">WebAgent::CookieUtils</a></li>
    183. 

  183. 				
    184. 

  184. 					<li><a href="../HTTP.html">HTTP</a></li>
    185. 

  185. 				
    186. 

  186. 					<li><a href="../HTTP/Message.html">HTTP::Message</a></li>
    187. 

  187. 				
    188. 

  188. 					<li><a href="../HTTP/Message/Body.html">HTTP::Message::Body</a></li>
    189. 

  189. 				
    190. 

  190. 					<li><a href="../HTTP/Message/Body/Parts.html">HTTP::Message::Body::Parts</a></li>
    191. 

  191. 				
    192. 

  192. 					<li><a href="../HTTP/Message/Headers.html">HTTP::Message::Headers</a></li>
    193. 

  193. 				
    194. 

  194. 					<li><a href="../HTTP/Status.html">HTTP::Status</a></li>
    195. 

  195. 				
    196. 

  196. 					<li><a href="../HexDump.html">HexDump</a></li>
    197. 

  197. 				
    198. 

  198. 					<li><a href="../OAuthClient.html">OAuthClient</a></li>
    199. 

  199. 				
    200. 

  200. 					<li><a href="../String.html">String</a></li>
    201. 

  201. 				
    202. 

  202. 				</ul>
    203. 

  203. 				<div id="no-class-search-results" style="display: none;">No matching classes.</div>
    204. 

  204. 			</div>
    205. 

  205. 

  206. 			
    207. 

  207. 		</div>
    208. 

  208. 	</div>
    209. 

  209. 

  210. 	<div id="documentation">
    211. 

  211. 		<h1 class="module">HTTPClient::Timeout</h1>
    212. 

  212. 

  213. 		<div id="description">
    214. 

  214. 			
    215. 

  215. 		</div>
    216. 

  216. 

  217. 		<!-- Constants -->
    218. 

  218. 		
    219. 

  219. 

  220. 		<!-- Attributes -->
    221. 

  221. 		
    222. 

  222. 

  223. 		<!-- Methods -->
    224. 

  224. 		
    225. 

  225. 		<div id="public-instance-method-details" class="method-section section">
    226. 

  226. 			<h3 class="section-header">Public Instance Methods</h3>
    227. 

  227. 

  228. 		
    229. 

  229. 			<div id="timeout-method" class="method-detail ">
    230. 

  230. 				<a name="method-i-timeout"></a>
    231. 

  231. 

  232. 				<div class="method-heading">
    233. 

  233. 				
    234. 

  234. 					<span class="method-name">timeout</span><span
    235. 

  235. 						class="method-args">(sec, ex = nil, &block)</span>
    236. 

  236. 					<span class="method-click-advice">click to toggle source</span>
    237. 

  237. 				
    238. 

  238. 				</div>
    239. 

  239. 

  240. 				<div class="method-description">
    241. 

  241. 					
    242. 

  242. 					
    243. 

  243. 					
    244. 

  244. 

  245. 					
    246. 

  246. 					<div class="method-source-code"
    247. 

  247. 						id="timeout-source">
    248. 

  248. <pre>
    249. 

  249.      <span class="ruby-comment cmt"># File lib/httpclient/timeout.rb, line 125</span>
    250. 

  250. 125:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">timeout</span>(<span class="ruby-identifier">sec</span>, <span class="ruby-identifier">ex</span> = <span class="ruby-keyword kw">nil</span>, &amp;<span class="ruby-identifier">block</span>)
    251. 

  251. 126:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">yield</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">sec</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">sec</span>.<span class="ruby-identifier">zero?</span>
    252. 

  252. 127:         <span class="ruby-identifier">scheduler</span> = <span class="ruby-keyword kw">nil</span>
    253. 

  253. 128:         <span class="ruby-keyword kw">begin</span>
    254. 

  254. 129:           <span class="ruby-identifier">scheduler</span> = <span class="ruby-constant">HTTPClient</span>.<span class="ruby-identifier">timeout_scheduler</span>
    255. 

  255. 130:           <span class="ruby-identifier">period</span> = <span class="ruby-identifier">scheduler</span>.<span class="ruby-identifier">register</span>(<span class="ruby-constant">Thread</span>.<span class="ruby-identifier">current</span>, <span class="ruby-identifier">sec</span>, <span class="ruby-identifier">ex</span>)
    256. 

  256. 131:           <span class="ruby-keyword kw">yield</span>(<span class="ruby-identifier">sec</span>)
    257. 

  257. 132:         <span class="ruby-keyword kw">ensure</span>
    258. 

  258. 133:           <span class="ruby-identifier">scheduler</span>.<span class="ruby-identifier">cancel</span>(<span class="ruby-identifier">period</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">scheduler</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">period</span>
    259. 

  259. 134:         <span class="ruby-keyword kw">end</span>
    260. 

  260. 135:       <span class="ruby-keyword kw">end</span></pre>
    261. 

  261. 					</div>
    262. 

  262. 					
    263. 

  263. 				</div>
    264. 

  264. 

  265. 				
    266. 

  266. 

  267. 				
    268. 

  268. 			</div>
    269. 

  269. 

  270. 		
    271. 

  271. 		</div>
    272. 

  272. 	
    273. 

  273. 

  274. 	</div>
    275. 

  275. 

  276. 

  277. 	<div id="rdoc-debugging-section-dump" class="debugging-section">
    278. 

  278. 	
    279. 

  279. 		<p>Disabled; run with --debug to generate this.</p>
    280. 

  280. 	
    281. 

  281. 	</div>
    282. 

  282. 

  283. 	<div id="validator-badges">
    284. 

  284. 		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
    285. 

  285. 		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
    286. 

  286. 			Rdoc Generator</a> 1.1.6</small>.</p>
    287. 

  287. 	</div>
    288. 

  288. 

  289. </body>
    290. 

  290. </html>
    291. 

  291. 

  292.