Apache_Solr_HttpTransport_Abstract.html 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  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_Abstract</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_Abstract</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-descendents">Descendents</a>
  19. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20. </div>
  21. <div class="info-box-body">
  22. <p class="implements">
  23. Implements interfaces:
  24. <ul>
  25. <li><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html">Apache_Solr_HttpTransport_Interface</a></li> </ul>
  26. </p>
  27. <!-- ========== Info from phpDoc block ========= -->
  28. <p class="short-description">Convenience class that implements the transport implementation. Can be extended by</p>
  29. <p class="description"><p>real implementations to do some of the common book keeping</p></p>
  30. <ul class="tags">
  31. <li><span class="field">abstract:</span> </li>
  32. </ul>
  33. <p class="notes">
  34. Located in <a class="field" href="_HttpTransport---Abstract.php.html">/HttpTransport/Abstract.php</a> (line <span class="field"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportAbstract.php.html#a43">43</a></span>)
  35. </p>
  36. <pre></pre>
  37. </div>
  38. </div>
  39. <a name="sec-descendents"></a>
  40. <div class="info-box">
  41. <div class="info-box-title">Direct descendents</div>
  42. <div class="nav-bar">
  43. <a href="#sec-description">Description</a> |
  44. <span class="disabled">Descendents</span>
  45. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  46. </div>
  47. <div class="info-box-body">
  48. <table cellpadding="2" cellspacing="0" class="class-table">
  49. <tr>
  50. <th class="class-table-header">Class</th>
  51. <th class="class-table-header">Description</th>
  52. </tr>
  53. <tr>
  54. <td style="padding-right: 2em"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_FileGetContents.html">Apache_Solr_HttpTransport_FileGetContents</a></td>
  55. <td>
  56. HTTP Transport implemenation that uses the builtin http URL wrappers and file_get_contents
  57. </td>
  58. </tr>
  59. <tr>
  60. <td style="padding-right: 2em"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Curl.html">Apache_Solr_HttpTransport_Curl</a></td>
  61. <td>
  62. A Curl based HTTP transport. Uses a single curl session for all requests.
  63. </td>
  64. </tr>
  65. <tr>
  66. <td style="padding-right: 2em"><a href="../../Apache/Solr/Apache_Solr_HttpTransport_CurlNoReuse.html">Apache_Solr_HttpTransport_CurlNoReuse</a></td>
  67. <td>
  68. An alternative Curl HTTP transport that opens and closes a curl session for every request. This isn't the recommended way to use curl, but some version of PHP have memory issues.
  69. </td>
  70. </tr>
  71. </table>
  72. </div>
  73. </div>
  74. <a name="sec-method-summary"></a>
  75. <div class="info-box">
  76. <div class="info-box-title">Method Summary</span></div>
  77. <div class="nav-bar">
  78. <a href="#sec-description">Description</a> |
  79. <a href="#sec-descendents">Descendents</a> |
  80. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  81. </div>
  82. <div class="info-box-body">
  83. <div class="method-summary">
  84. <div class="method-definition">
  85. <span class="method-result">float</span>
  86. <a href="#getDefaultTimeout" title="details" class="method-name">getDefaultTimeout</a>
  87. ()
  88. </div>
  89. <div class="method-definition">
  90. <span class="method-result">void</span>
  91. <a href="#setDefaultTimeout" title="details" class="method-name">setDefaultTimeout</a>
  92. (<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span>)
  93. </div>
  94. </div>
  95. </div>
  96. </div>
  97. <a name="sec-methods"></a>
  98. <div class="info-box">
  99. <div class="info-box-title">Methods</div>
  100. <div class="nav-bar">
  101. <a href="#sec-description">Description</a> |
  102. <a href="#sec-descendents">Descendents</a> |
  103. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  104. </div>
  105. <div class="info-box-body">
  106. <A NAME='method_detail'></A>
  107. <a name="methodgetDefaultTimeout" id="getDefaultTimeout"><!-- --></a>
  108. <div class="evenrow">
  109. <div class="method-header">
  110. <span class="method-title">getDefaultTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportAbstract.php.html#a58">58</a></span>)
  111. </div>
  112. <!-- ========== Info from phpDoc block ========= -->
  113. <p class="short-description">Get the current default timeout setting (initially the default_socket_timeout ini setting) in seconds</p>
  114. <ul class="tags">
  115. <li><span class="field">access:</span> public</li>
  116. </ul>
  117. <div class="method-signature">
  118. <span class="method-result">float</span>
  119. <span class="method-name">
  120. getDefaultTimeout
  121. </span>
  122. ()
  123. </div>
  124. <hr class="separator" />
  125. <div class="notes">Implementation of:</div>
  126. <dl>
  127. <dt><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html#methodgetDefaultTimeout">Apache_Solr_HttpTransport_Interface::getDefaultTimeout()</a></dt>
  128. <dd>Get the current default timeout for all HTTP requests</dd>
  129. </dl>
  130. </div>
  131. <a name="methodsetDefaultTimeout" id="setDefaultTimeout"><!-- --></a>
  132. <div class="oddrow">
  133. <div class="method-header">
  134. <span class="method-title">setDefaultTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_HttpTransportAbstract.php.html#a80">80</a></span>)
  135. </div>
  136. <!-- ========== Info from phpDoc block ========= -->
  137. <p class="short-description">Set the current default timeout for all HTTP requests</p>
  138. <ul class="tags">
  139. <li><span class="field">access:</span> public</li>
  140. </ul>
  141. <div class="method-signature">
  142. <span class="method-result">void</span>
  143. <span class="method-name">
  144. setDefaultTimeout
  145. </span>
  146. (<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span>)
  147. </div>
  148. <ul class="parameters">
  149. <li>
  150. <span class="var-type">float</span>
  151. <span class="var-name">$timeout</span> </li>
  152. </ul>
  153. <hr class="separator" />
  154. <div class="notes">Implementation of:</div>
  155. <dl>
  156. <dt><a href="../../Apache/Solr/Apache_Solr_HttpTransport_Interface.html#methodsetDefaultTimeout">Apache_Solr_HttpTransport_Interface::setDefaultTimeout()</a></dt>
  157. <dd>Set the current default timeout for all HTTP requests</dd>
  158. </dl>
  159. </div>
  160. </div>
  161. </div>
  162. <p class="notes" id="credit">
  163. Documentation generated on Wed, 04 May 2011 11:01:08 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
  164. </p>
  165. </div></body>
  166. </html>