Home Explore Help
Sign In
bachir
/
materio-base-d7
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 6a402551d7
Branches Tags
materio-base...
/
SolrPhpClient
/
phpdocs
/
Apache
/
Solr
/
Apache_Solr_HttpTransport_Interface.html

Apache_Solr_HttpTransport_Interface.html 11 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260 
  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">
    4. 

  4. 		<head>
    5. 

  5. 			<!-- template designed by Marco Von Ballmoos -->
    6. 

  6. 			<title>Docs For Class Apache_Solr_HttpTransport_Interface</title>
    7. 

  7. 			<link rel="stylesheet" href="../../media/stylesheet.css" />
    8. 

  8. 			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
    9. 

  9. 		</head>
    10. 

  10. 		<body>
    11. 

  11. 			<div class="page-body">			
    12. 

  12. <h2 class="class-name">Interface Apache_Solr_HttpTransport_Interface</h2>
    13. 

  13. 

  14. <a name="sec-description"></a>
    15. 

  15. <div class="info-box">
    16. 

  16. 	<div class="info-box-title">Description</div>
    17. 

  17. 	<div class="nav-bar">
    18. 

  18. 					<span class="disabled">Description</span> |
    19. 

  19. 															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    20. 

  20. 						
    21. 

  21. 					</div>
    22. 

  22. 	<div class="info-box-body">
    23. 

  23.         		<!-- ========== Info from phpDoc block ========= -->
    24. 

  24. <p class="short-description">Interface that all Transport (HTTP Requester) implementations must implement. These</p>
    25. 

  25. <p class="description"><p>Implementations can then be plugged into the Service instance in order to user their  the desired method for making HTTP requests</p></p>
    26. 

  26. 		<p class="notes">
    27. 

  27. 			Located in <a class="field" href="_HttpTransport---Interface.php.html">/HttpTransport/Interface.php</a> (line <span class="field"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportInterface.php.html#a47">47</a></span>)
    28. 

  28. 		</p>
    29. 

  29. 		
    30. 

  30. 				
    31. 

  31. 		<pre></pre>
    32. 

  32. 	
    33. 

  33. 			</div>
    34. 

  34. </div>
    35. 

  35. 

  36. 

  37. 

  38. 

  39. 	<a name="sec-method-summary"></a>
    40. 

  40. 	<div class="info-box">
    41. 

  41. 		<div class="info-box-title">Method Summary</span></div>
    42. 

  42. 		<div class="nav-bar">
    43. 

  43. 			<a href="#sec-description">Description</a> |
    44. 

  44. 												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
    45. 

  45. 		</div>
    46. 

  46. 		<div class="info-box-body">			
    47. 

  47. 			<div class="method-summary">
    48. 

  48. 																																																						
    49. 

  49. 				<div class="method-definition">
    50. 

  50. 											<span class="method-result">float</span>
    51. 

  51. 										<a href="#getDefaultTimeout" title="details" class="method-name">getDefaultTimeout</a>
    52. 

  52. 										()
    53. 

  53. 									</div>
    54. 

  54. 														
    55. 

  55. 				<div class="method-definition">
    56. 

  56. 											<span class="method-result"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
    57. 

  57. 										<a href="#performGetRequest" title="details" class="method-name">performGetRequest</a>
    58. 

  58. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
    59. 

  59. 									</div>
    60. 

  60. 														
    61. 

  61. 				<div class="method-definition">
    62. 

  62. 											<span class="method-result"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
    63. 

  63. 										<a href="#performHeadRequest" title="details" class="method-name">performHeadRequest</a>
    64. 

  64. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
    65. 

  65. 									</div>
    66. 

  66. 														
    67. 

  67. 				<div class="method-definition">
    68. 

  68. 											<span class="method-result"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
    69. 

  69. 										<a href="#performPostRequest" title="details" class="method-name">performPostRequest</a>
    70. 

  70. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$contentType</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
    71. 

  71. 									</div>
    72. 

  72. 														
    73. 

  73. 				<div class="method-definition">
    74. 

  74. 											<span class="method-result">void</span>
    75. 

  75. 										<a href="#setDefaultTimeout" title="details" class="method-name">setDefaultTimeout</a>
    76. 

  76. 											(<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span>)
    77. 

  77. 									</div>
    78. 

  78. 											</div>
    79. 

  79. 		</div>
    80. 

  80. 	</div>		
    81. 

  81. 

  82. 	
    83. 

  83. 	<a name="sec-methods"></a>
    84. 

  84. 	<div class="info-box">
    85. 

  85. 		<div class="info-box-title">Methods</div>
    86. 

  86. 		<div class="nav-bar">
    87. 

  87. 			<a href="#sec-description">Description</a> |
    88. 

  88. 																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
    89. 

  89. 						
    90. 

  90. 		</div>
    91. 

  91. 		<div class="info-box-body">
    92. 

  92. 			<A NAME='method_detail'></A>
    93. 

  93. <a name="methodgetDefaultTimeout" id="getDefaultTimeout"><!-- --></a>
    94. 

  94. <div class="oddrow">
    95. 

  95. 	
    96. 

  96. 	<div class="method-header">
    97. 

  97. 		<span class="method-title">getDefaultTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportInterface.php.html#a54">54</a></span>)
    98. 

  98. 	</div> 
    99. 

  99. 	
    100. 

  100. 	<!-- ========== Info from phpDoc block ========= -->
    101. 

  101. <p class="short-description">Get the current default timeout for all HTTP requests</p>
    102. 

  102. 	<ul class="tags">
    103. 

  103. 				<li><span class="field">access:</span> public</li>
    104. 

  104. 			</ul>
    105. 

  105. 	
    106. 

  106. 	<div class="method-signature">
    107. 

  107. 		<span class="method-result">float</span>
    108. 

  108. 		<span class="method-name">
    109. 

  109. 			getDefaultTimeout
    110. 

  110. 		</span>
    111. 

  111. 				()
    112. 

  112. 			</div>
    113. 

  113. 	
    114. 

  114. 		
    115. 

  115. 			
    116. 

  116. 	</div>
    117. 

  117. <a name="methodperformGetRequest" id="performGetRequest"><!-- --></a>
    118. 

  118. <div class="evenrow">
    119. 

  119. 	
    120. 

  120. 	<div class="method-header">
    121. 

  121. 		<span class="method-title">performGetRequest</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportInterface.php.html#a71">71</a></span>)
    122. 

  122. 	</div> 
    123. 

  123. 	
    124. 

  124. 	<!-- ========== Info from phpDoc block ========= -->
    125. 

  125. <p class="short-description">Perform a GET HTTP operation with an optional timeout and return the response  contents, use getLastResponseHeaders to retrieve HTTP headers</p>
    126. 

  126. 	<ul class="tags">
    127. 

  127. 				<li><span class="field">return:</span> HTTP response</li>
    128. 

  128. 				<li><span class="field">access:</span> public</li>
    129. 

  129. 			</ul>
    130. 

  130. 	
    131. 

  131. 	<div class="method-signature">
    132. 

  132. 		<span class="method-result"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
    133. 

  133. 		<span class="method-name">
    134. 

  134. 			performGetRequest
    135. 

  135. 		</span>
    136. 

  136. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
    137. 

  137. 			</div>
    138. 

  138. 	
    139. 

  139. 			<ul class="parameters">
    140. 

  140. 					<li>
    141. 

  141. 				<span class="var-type">string</span>
    142. 

  142. 				<span class="var-name">$url</span>			</li>
    143. 

  143. 					<li>
    144. 

  144. 				<span class="var-type">float</span>
    145. 

  145. 				<span class="var-name">$timeout</span>			</li>
    146. 

  146. 				</ul>
    147. 

  147. 		
    148. 

  148. 			
    149. 

  149. 	</div>
    150. 

  150. <a name="methodperformHeadRequest" id="performHeadRequest"><!-- --></a>
    151. 

  151. <div class="oddrow">
    152. 

  152. 	
    153. 

  153. 	<div class="method-header">
    154. 

  154. 		<span class="method-title">performHeadRequest</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportInterface.php.html#a81">81</a></span>)
    155. 

  155. 	</div> 
    156. 

  156. 	
    157. 

  157. 	<!-- ========== Info from phpDoc block ========= -->
    158. 

  158. <p class="short-description">Perform a HEAD HTTP operation with an optional timeout and return the response  headers - NOTE: head requests have no response body</p>
    159. 

  159. 	<ul class="tags">
    160. 

  160. 				<li><span class="field">return:</span> HTTP response</li>
    161. 

  161. 				<li><span class="field">access:</span> public</li>
    162. 

  162. 			</ul>
    163. 

  163. 	
    164. 

  164. 	<div class="method-signature">
    165. 

  165. 		<span class="method-result"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
    166. 

  166. 		<span class="method-name">
    167. 

  167. 			performHeadRequest
    168. 

  168. 		</span>
    169. 

  169. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
    170. 

  170. 			</div>
    171. 

  171. 	
    172. 

  172. 			<ul class="parameters">
    173. 

  173. 					<li>
    174. 

  174. 				<span class="var-type">string</span>
    175. 

  175. 				<span class="var-name">$url</span>			</li>
    176. 

  176. 					<li>
    177. 

  177. 				<span class="var-type">float</span>
    178. 

  178. 				<span class="var-name">$timeout</span>			</li>
    179. 

  179. 				</ul>
    180. 

  180. 		
    181. 

  181. 			
    182. 

  182. 	</div>
    183. 

  183. <a name="methodperformPostRequest" id="performPostRequest"><!-- --></a>
    184. 

  184. <div class="evenrow">
    185. 

  185. 	
    186. 

  186. 	<div class="method-header">
    187. 

  187. 		<span class="method-title">performPostRequest</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportInterface.php.html#a93">93</a></span>)
    188. 

  188. 	</div> 
    189. 

  189. 	
    190. 

  190. 	<!-- ========== Info from phpDoc block ========= -->
    191. 

  191. <p class="short-description">Perform a POST HTTP operation with an optional timeout and return the response  contents, use getLastResponseHeaders to retrieve HTTP headers</p>
    192. 

  192. 	<ul class="tags">
    193. 

  193. 				<li><span class="field">return:</span> HTTP response</li>
    194. 

  194. 				<li><span class="field">access:</span> public</li>
    195. 

  195. 			</ul>
    196. 

  196. 	
    197. 

  197. 	<div class="method-signature">
    198. 

  198. 		<span class="method-result"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Response.html">Apache_Solr_HttpTransport_Response</a></span>
    199. 

  199. 		<span class="method-name">
    200. 

  200. 			performPostRequest
    201. 

  201. 		</span>
    202. 

  202. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$contentType</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
    203. 

  203. 			</div>
    204. 

  204. 	
    205. 

  205. 			<ul class="parameters">
    206. 

  206. 					<li>
    207. 

  207. 				<span class="var-type">string</span>
    208. 

  208. 				<span class="var-name">$url</span>			</li>
    209. 

  209. 					<li>
    210. 

  210. 				<span class="var-type">string</span>
    211. 

  211. 				<span class="var-name">$rawPost</span>			</li>
    212. 

  212. 					<li>
    213. 

  213. 				<span class="var-type">string</span>
    214. 

  214. 				<span class="var-name">$contentType</span>			</li>
    215. 

  215. 					<li>
    216. 

  216. 				<span class="var-type">float</span>
    217. 

  217. 				<span class="var-name">$timeout</span>			</li>
    218. 

  218. 				</ul>
    219. 

  219. 		
    220. 

  220. 			
    221. 

  221. 	</div>
    222. 

  222. <a name="methodsetDefaultTimeout" id="setDefaultTimeout"><!-- --></a>
    223. 

  223. <div class="oddrow">
    224. 

  224. 	
    225. 

  225. 	<div class="method-header">
    226. 

  226. 		<span class="method-title">setDefaultTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportInterface.php.html#a61">61</a></span>)
    227. 

  227. 	</div> 
    228. 

  228. 	
    229. 

  229. 	<!-- ========== Info from phpDoc block ========= -->
    230. 

  230. <p class="short-description">Set the current default timeout for all HTTP requests</p>
    231. 

  231. 	<ul class="tags">
    232. 

  232. 				<li><span class="field">access:</span> public</li>
    233. 

  233. 			</ul>
    234. 

  234. 	
    235. 

  235. 	<div class="method-signature">
    236. 

  236. 		<span class="method-result">void</span>
    237. 

  237. 		<span class="method-name">
    238. 

  238. 			setDefaultTimeout
    239. 

  239. 		</span>
    240. 

  240. 					(<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span>)
    241. 

  241. 			</div>
    242. 

  242. 	
    243. 

  243. 			<ul class="parameters">
    244. 

  244. 					<li>
    245. 

  245. 				<span class="var-type">float</span>
    246. 

  246. 				<span class="var-name">$timeout</span>			</li>
    247. 

  247. 				</ul>
    248. 

  248. 		
    249. 

  249. 			
    250. 

  250. 	</div>
    251. 

  251. 						
    252. 

  252. 		</div>
    253. 

  253. 	</div>
    254. 

  254. 

  255. 

  256. 	<p class="notes" id="credit">
    257. 

  257. 		Documentation generated on Wed, 04 May 2011 11:01:15 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
    258. 

  258. 	</p>
    259. 

  259. 	</div></body>
    260. 

  260. </html>
    261.