Apache_Solr_HttpTransport_Curl.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs For Class Apache_Solr_HttpTransport_Curl</title>
  7. <link rel="stylesheet" href="../../media/stylesheet.css" />
  8. <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  9. </head>
  10. <body>
  11. <div class="page-body">
  12. <h2 class="class-name">Class Apache_Solr_HttpTransport_Curl</h2>
  13. <a name="sec-description"></a>
  14. <div class="info-box">
  15. <div class="info-box-title">Description</div>
  16. <div class="nav-bar">
  17. <span class="disabled">Description</span> |
  18. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  19. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  20. </div>
  21. <div class="info-box-body">
  22. <!-- ========== Info from phpDoc block ========= -->
  23. <p class="short-description">A Curl based HTTP transport. Uses a single curl session for all requests.</p>
  24. <p class="notes">
  25. Located in <a class="field" href="_HttpTransport---Curl.php.html">/HttpTransport/Curl.php</a> (line <span class="field"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportCurl.php.html#a45">45</a></span>)
  26. </p>
  27. <pre><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Abstract.html">Apache_Solr_HttpTransport_Abstract</a>
  28. |
  29. --Apache_Solr_HttpTransport_Curl</pre>
  30. </div>
  31. </div>
  32. <a name="sec-const-summary"></a>
  33. <div class="info-box">
  34. <div class="info-box-title">Class Constant Summary</span></div>
  35. <div class="nav-bar">
  36. <a href="#sec-description">Description</a> |
  37. <span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
  38. |
  39. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  40. </div>
  41. <div class="info-box-body">
  42. <div class="const-summary">
  43. <div class="const-title">
  44. <img src="../../media/images/Constant.png" alt=" " />
  45. <a href="#SVN_ID" title="details" class="const-name">SVN_ID</a> = <span class="var-type"> '$Id:$'</span>
  46. </div>
  47. <div class="const-title">
  48. <img src="../../media/images/Constant.png" alt=" " />
  49. <a href="#SVN_REVISION" title="details" class="const-name">SVN_REVISION</a> = <span class="var-type"> '$Revision:$'</span>
  50. </div>
  51. </div>
  52. </div>
  53. </div>
  54. <a name="sec-method-summary"></a>
  55. <div class="info-box">
  56. <div class="info-box-title">Method Summary</span></div>
  57. <div class="nav-bar">
  58. <a href="#sec-description">Description</a> |
  59. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  60. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  61. </div>
  62. <div class="info-box-body">
  63. <div class="method-summary">
  64. <div class="method-definition">
  65. <span class="method-result">Apache_Solr_HttpTransport_Curl</span>
  66. <a href="#__construct" title="details" class="method-name">__construct</a>
  67. ()
  68. </div>
  69. <div class="method-definition">
  70. <span class="method-result">void</span>
  71. <a href="#__destruct" title="details" class="method-name">__destruct</a>
  72. ()
  73. </div>
  74. <div class="method-definition">
  75. <span class="method-result">void</span>
  76. <a href="#performGetRequest" title="details" class="method-name">performGetRequest</a>
  77. (<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
  78. </div>
  79. <div class="method-definition">
  80. <span class="method-result">void</span>
  81. <a href="#performHeadRequest" title="details" class="method-name">performHeadRequest</a>
  82. (<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
  83. </div>
  84. <div class="method-definition">
  85. <span class="method-result">void</span>
  86. <a href="#performPostRequest" title="details" class="method-name">performPostRequest</a>
  87. (<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$postData</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contentType</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
  88. </div>
  89. </div>
  90. </div>
  91. </div>
  92. <a name="sec-methods"></a>
  93. <div class="info-box">
  94. <div class="info-box-title">Methods</div>
  95. <div class="nav-bar">
  96. <a href="#sec-description">Description</a> |
  97. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  98. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  99. </div>
  100. <div class="info-box-body">
  101. <A NAME='method_detail'></A>
  102. <a name="method__construct" id="__construct"><!-- --></a>
  103. <div class="evenrow">
  104. <div class="method-header">
  105. <span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportCurl.php.html#a67">67</a></span>)
  106. </div>
  107. <!-- ========== Info from phpDoc block ========= -->
  108. <p class="short-description">Initializes a curl session</p>
  109. <ul class="tags">
  110. <li><span class="field">access:</span> public</li>
  111. </ul>
  112. <div class="method-signature">
  113. <span class="method-result">Apache_Solr_HttpTransport_Curl</span>
  114. <span class="method-name">
  115. __construct
  116. </span>
  117. ()
  118. </div>
  119. </div>
  120. <a name="method__destruct" id="__destruct"><!-- --></a>
  121. <div class="oddrow">
  122. <div class="method-header">
  123. <span class="method-title">Destructor __destruct</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportCurl.php.html#a88">88</a></span>)
  124. </div>
  125. <!-- ========== Info from phpDoc block ========= -->
  126. <p class="short-description">Closes a curl session</p>
  127. <div class="method-signature">
  128. <span class="method-result">void</span>
  129. <span class="method-name">
  130. __destruct
  131. </span>
  132. ()
  133. </div>
  134. </div>
  135. <a name="methodperformGetRequest" id="performGetRequest"><!-- --></a>
  136. <div class="evenrow">
  137. <div class="method-header">
  138. <span class="method-title">performGetRequest</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportCurl.php.html#a94">94</a></span>)
  139. </div>
  140. <!-- ========== Info from phpDoc block ========= -->
  141. <ul class="tags">
  142. <li><span class="field">access:</span> public</li>
  143. </ul>
  144. <div class="method-signature">
  145. <span class="method-result">void</span>
  146. <span class="method-name">
  147. performGetRequest
  148. </span>
  149. (<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
  150. </div>
  151. <ul class="parameters">
  152. <li>
  153. <span class="var-type"></span>
  154. <span class="var-name">$url</span> </li>
  155. <li>
  156. <span class="var-type"></span>
  157. <span class="var-name">$timeout</span> </li>
  158. </ul>
  159. </div>
  160. <a name="methodperformHeadRequest" id="performHeadRequest"><!-- --></a>
  161. <div class="oddrow">
  162. <div class="method-header">
  163. <span class="method-title">performHeadRequest</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportCurl.php.html#a128">128</a></span>)
  164. </div>
  165. <!-- ========== Info from phpDoc block ========= -->
  166. <ul class="tags">
  167. <li><span class="field">access:</span> public</li>
  168. </ul>
  169. <div class="method-signature">
  170. <span class="method-result">void</span>
  171. <span class="method-name">
  172. performHeadRequest
  173. </span>
  174. (<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
  175. </div>
  176. <ul class="parameters">
  177. <li>
  178. <span class="var-type"></span>
  179. <span class="var-name">$url</span> </li>
  180. <li>
  181. <span class="var-type"></span>
  182. <span class="var-name">$timeout</span> </li>
  183. </ul>
  184. </div>
  185. <a name="methodperformPostRequest" id="performPostRequest"><!-- --></a>
  186. <div class="evenrow">
  187. <div class="method-header">
  188. <span class="method-title">performPostRequest</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportCurl.php.html#a159">159</a></span>)
  189. </div>
  190. <!-- ========== Info from phpDoc block ========= -->
  191. <ul class="tags">
  192. <li><span class="field">access:</span> public</li>
  193. </ul>
  194. <div class="method-signature">
  195. <span class="method-result">void</span>
  196. <span class="method-name">
  197. performPostRequest
  198. </span>
  199. (<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$postData</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$contentType</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">false</span>])
  200. </div>
  201. <ul class="parameters">
  202. <li>
  203. <span class="var-type"></span>
  204. <span class="var-name">$url</span> </li>
  205. <li>
  206. <span class="var-type"></span>
  207. <span class="var-name">$postData</span> </li>
  208. <li>
  209. <span class="var-type"></span>
  210. <span class="var-name">$contentType</span> </li>
  211. <li>
  212. <span class="var-type"></span>
  213. <span class="var-name">$timeout</span> </li>
  214. </ul>
  215. </div>
  216. <h4>Inherited Methods</h4>
  217. <a name='inherited_methods'><!-- --></a>
  218. <!-- =========== Summary =========== -->
  219. <p>Inherited From <span class="classname"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Abstract.html">Apache_Solr_HttpTransport_Abstract</a></span></p>
  220. <blockquote>
  221. <span class="method-name"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Abstract.html#methodgetDefaultTimeout">Apache_Solr_HttpTransport_Abstract::getDefaultTimeout()</a></span><br>
  222. <span class="method-name"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Abstract.html#methodsetDefaultTimeout">Apache_Solr_HttpTransport_Abstract::setDefaultTimeout()</a></span><br>
  223. </blockquote>
  224. </div>
  225. </div>
  226. <a name="sec-consts"></a>
  227. <div class="info-box">
  228. <div class="info-box-title">Class Constants</div>
  229. <div class="nav-bar">
  230. <a href="#sec-description">Description</a> |
  231. <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
  232. |
  233. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  234. </div>
  235. <div class="info-box-body">
  236. <a name="constSVN_ID" id="SVN_ID"><!-- --></A>
  237. <div class="oddrow">
  238. <div class="const-header">
  239. <img src="../../media/images/Variable.png" />
  240. <span class="const-title">
  241. <span class="const-name">SVN_ID</span>
  242. = <span class="const-default"> '$Id:$'</span>
  243. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportCurl.php.html#a55">55</a></span>)
  244. </span>
  245. </div>
  246. <!-- ========== Info from phpDoc block ========= -->
  247. <p class="short-description">SVN ID meta data for this class</p>
  248. </div>
  249. <a name="constSVN_REVISION" id="SVN_REVISION"><!-- --></A>
  250. <div class="evenrow">
  251. <div class="const-header">
  252. <img src="../../media/images/Variable.png" />
  253. <span class="const-title">
  254. <span class="const-name">SVN_REVISION</span>
  255. = <span class="const-default"> '$Revision:$'</span>
  256. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportCurl.php.html#a50">50</a></span>)
  257. </span>
  258. </div>
  259. <!-- ========== Info from phpDoc block ========= -->
  260. <p class="short-description">SVN Revision meta data for this class</p>
  261. </div>
  262. </div>
  263. </div>
  264. <p class="notes" id="credit">
  265. Documentation generated on Wed, 04 May 2011 11:01:12 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
  266. </p>
  267. </div></body>
  268. </html>