Apache_Solr_Service_Balancer.html 72 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606
  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_Service_Balancer</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_Service_Balancer</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  19. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  21. </div>
  22. <div class="info-box-body">
  23. <!-- ========== Info from phpDoc block ========= -->
  24. <p class="short-description">Reference Implementation for using multiple Solr services in a distribution. Functionality</p>
  25. <p class="description"><p>includes: routing of read / write operations failover (on selection) for multiple read servers</p></p>
  26. <p class="notes">
  27. Located in <a class="field" href="_Service---Balancer.php.html">/Service/Balancer.php</a> (line <span class="field"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a51">51</a></span>)
  28. </p>
  29. <pre></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. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  39. |
  40. |
  41. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  42. </div>
  43. <div class="info-box-body">
  44. <div class="const-summary">
  45. <div class="const-title">
  46. <img src="../../media/images/Constant.png" alt=" " />
  47. <a href="#SVN_ID" title="details" class="const-name">SVN_ID</a> = <span class="var-type"> '$Id: Balancer.php 54 2011-02-04 16:29:18Z donovan.jimenez $'</span>
  48. </div>
  49. <div class="const-title">
  50. <img src="../../media/images/Constant.png" alt=" " />
  51. <a href="#SVN_REVISION" title="details" class="const-name">SVN_REVISION</a> = <span class="var-type"> '$Revision: 54 $'</span>
  52. </div>
  53. </div>
  54. </div>
  55. </div>
  56. <a name="sec-var-summary"></a>
  57. <div class="info-box">
  58. <div class="info-box-title">Variable Summary</span></div>
  59. <div class="nav-bar">
  60. <a href="#sec-description">Description</a> |
  61. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  62. |
  63. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  64. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  65. </div>
  66. <div class="info-box-body">
  67. <div class="var-summary">
  68. <div class="var-title">
  69. <span class="var-type">mixed</span>
  70. <a href="#$_backoffEscalation" title="details" class="var-name">$_backoffEscalation</a>
  71. </div>
  72. <div class="var-title">
  73. <span class="var-type">mixed</span>
  74. <a href="#$_backoffLimit" title="details" class="var-name">$_backoffLimit</a>
  75. </div>
  76. <div class="var-title">
  77. <span class="var-type">mixed</span>
  78. <a href="#$_createDocuments" title="details" class="var-name">$_createDocuments</a>
  79. </div>
  80. <div class="var-title">
  81. <span class="var-type">mixed</span>
  82. <a href="#$_currentReadService" title="details" class="var-name">$_currentReadService</a>
  83. </div>
  84. <div class="var-title">
  85. <span class="var-type">mixed</span>
  86. <a href="#$_currentWriteService" title="details" class="var-name">$_currentWriteService</a>
  87. </div>
  88. <div class="var-title">
  89. <span class="var-type">mixed</span>
  90. <a href="#$_defaultBackoff" title="details" class="var-name">$_defaultBackoff</a>
  91. </div>
  92. <div class="var-title">
  93. <span class="var-type">mixed</span>
  94. <a href="#$_readableServices" title="details" class="var-name">$_readableServices</a>
  95. </div>
  96. <div class="var-title">
  97. <span class="var-type">mixed</span>
  98. <a href="#$_readPingTimeout" title="details" class="var-name">$_readPingTimeout</a>
  99. </div>
  100. <div class="var-title">
  101. <span class="var-type">mixed</span>
  102. <a href="#$_useBackoff" title="details" class="var-name">$_useBackoff</a>
  103. </div>
  104. <div class="var-title">
  105. <span class="var-type">mixed</span>
  106. <a href="#$_writeableServices" title="details" class="var-name">$_writeableServices</a>
  107. </div>
  108. <div class="var-title">
  109. <span class="var-type">mixed</span>
  110. <a href="#$_writePingTimeout" title="details" class="var-name">$_writePingTimeout</a>
  111. </div>
  112. </div>
  113. </div>
  114. </div>
  115. <a name="sec-method-summary"></a>
  116. <div class="info-box">
  117. <div class="info-box-title">Method Summary</span></div>
  118. <div class="nav-bar">
  119. <a href="#sec-description">Description</a> |
  120. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  121. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  122. |
  123. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  124. </div>
  125. <div class="info-box-body">
  126. <div class="method-summary">
  127. <div class="method-definition">
  128. static <span class="method-result">string</span>
  129. <a href="#escape" title="details" class="method-name">escape</a>
  130. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  131. </div>
  132. <div class="method-definition">
  133. static <span class="method-result">string</span>
  134. <a href="#escapePhrase" title="details" class="method-name">escapePhrase</a>
  135. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  136. </div>
  137. <div class="method-definition">
  138. static <span class="method-result">string</span>
  139. <a href="#phrase" title="details" class="method-name">phrase</a>
  140. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  141. </div>
  142. <div class="method-definition">
  143. <span class="method-result">Apache_Solr_Service_Balancer</span>
  144. <a href="#__construct" title="details" class="method-name">__construct</a>
  145. ([<span class="var-type">array</span>&nbsp;<span class="var-name">$readableServices</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$writeableServices</span> = <span class="var-default">array()</span>])
  146. </div>
  147. <div class="method-definition">
  148. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  149. <a href="#add" title="details" class="method-name">add</a>
  150. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>)
  151. </div>
  152. <div class="method-definition">
  153. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  154. <a href="#addDocument" title="details" class="method-name">addDocument</a>
  155. (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>])
  156. </div>
  157. <div class="method-definition">
  158. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  159. <a href="#addDocuments" title="details" class="method-name">addDocuments</a>
  160. (<span class="var-type">array</span>&nbsp;<span class="var-name">$documents</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>])
  161. </div>
  162. <div class="method-definition">
  163. <span class="method-result">void</span>
  164. <a href="#addReadService" title="details" class="method-name">addReadService</a>
  165. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$service</span>)
  166. </div>
  167. <div class="method-definition">
  168. <span class="method-result">void</span>
  169. <a href="#addWriteService" title="details" class="method-name">addWriteService</a>
  170. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$service</span>)
  171. </div>
  172. <div class="method-definition">
  173. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  174. <a href="#commit" title="details" class="method-name">commit</a>
  175. ([<span class="var-type"></span>&nbsp;<span class="var-name">$optimize</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  176. </div>
  177. <div class="method-definition">
  178. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  179. <a href="#delete" title="details" class="method-name">delete</a>
  180. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  181. </div>
  182. <div class="method-definition">
  183. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  184. <a href="#deleteById" title="details" class="method-name">deleteById</a>
  185. (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  186. </div>
  187. <div class="method-definition">
  188. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  189. <a href="#deleteByMultipleIds" title="details" class="method-name">deleteByMultipleIds</a>
  190. (<span class="var-type">array</span>&nbsp;<span class="var-name">$ids</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  191. </div>
  192. <div class="method-definition">
  193. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  194. <a href="#deleteByQuery" title="details" class="method-name">deleteByQuery</a>
  195. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawQuery</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  196. </div>
  197. <div class="method-definition">
  198. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  199. <a href="#extract" title="details" class="method-name">extract</a>
  200. (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  201. </div>
  202. <div class="method-definition">
  203. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  204. <a href="#extractFromString" title="details" class="method-name">extractFromString</a>
  205. (<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  206. </div>
  207. <div class="method-definition">
  208. <span class="method-result">boolean</span>
  209. <a href="#getCreateDocuments" title="details" class="method-name">getCreateDocuments</a>
  210. ()
  211. </div>
  212. <div class="method-definition">
  213. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  214. <a href="#optimize" title="details" class="method-name">optimize</a>
  215. ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  216. </div>
  217. <div class="method-definition">
  218. <span class="method-result">void</span>
  219. <a href="#removeReadService" title="details" class="method-name">removeReadService</a>
  220. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$service</span>)
  221. </div>
  222. <div class="method-definition">
  223. <span class="method-result">void</span>
  224. <a href="#removeWriteService" title="details" class="method-name">removeWriteService</a>
  225. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$service</span>)
  226. </div>
  227. <div class="method-definition">
  228. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  229. <a href="#search" title="details" class="method-name">search</a>
  230. (<span class="var-type">string</span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">10</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">Apache_Solr_Service::METHOD_GET</span>])
  231. </div>
  232. <div class="method-definition">
  233. <span class="method-result">void</span>
  234. <a href="#setCreateDocuments" title="details" class="method-name">setCreateDocuments</a>
  235. (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$createDocuments</span>)
  236. </div>
  237. <div class="method-definition">
  238. <span class="method-result">void</span>
  239. <a href="#setReadPingTimeout" title="details" class="method-name">setReadPingTimeout</a>
  240. (<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span>)
  241. </div>
  242. <div class="method-definition">
  243. <span class="method-result">void</span>
  244. <a href="#setUseBackoff" title="details" class="method-name">setUseBackoff</a>
  245. (<span class="var-type"></span>&nbsp;<span class="var-name">$enable</span>)
  246. </div>
  247. <div class="method-definition">
  248. <span class="method-result">void</span>
  249. <a href="#setWritePingTimeout" title="details" class="method-name">setWritePingTimeout</a>
  250. (<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span>)
  251. </div>
  252. <div class="method-definition">
  253. <span class="method-result">string</span>
  254. <a href="#_getServiceId" title="details" class="method-name">_getServiceId</a>
  255. (<span class="var-type">string</span>&nbsp;<span class="var-name">$host</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$port</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
  256. </div>
  257. <div class="method-definition">
  258. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Service.html">Apache_Solr_Service</a></span>
  259. <a href="#_selectReadService" title="details" class="method-name">_selectReadService</a>
  260. ([<span class="var-type"></span>&nbsp;<span class="var-name">$forceSelect</span> = <span class="var-default">false</span>])
  261. </div>
  262. <div class="method-definition">
  263. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Service.html">Apache_Solr_Service</a></span>
  264. <a href="#_selectWriteService" title="details" class="method-name">_selectWriteService</a>
  265. ([<span class="var-type"></span>&nbsp;<span class="var-name">$forceSelect</span> = <span class="var-default">false</span>])
  266. </div>
  267. <div class="method-definition">
  268. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Service.html">Apache_Solr_Service</a></span>
  269. <a href="#_selectWriteServiceSafe" title="details" class="method-name">_selectWriteServiceSafe</a>
  270. ([<span class="var-type"></span>&nbsp;<span class="var-name">$forceSelect</span> = <span class="var-default">false</span>])
  271. </div>
  272. </div>
  273. </div>
  274. </div>
  275. <a name="sec-vars"></a>
  276. <div class="info-box">
  277. <div class="info-box-title">Variables</div>
  278. <div class="nav-bar">
  279. <a href="#sec-description">Description</a> |
  280. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  281. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  282. |
  283. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  284. </div>
  285. <div class="info-box-body">
  286. <a name="var$_backoffEscalation" id="$_backoffEscalation"><!-- --></A>
  287. <div class="evenrow">
  288. <div class="var-header">
  289. <span class="var-title">
  290. <span class="var-type">mixed</span>
  291. <span class="var-name">$_backoffEscalation</span>
  292. = <span class="var-default"> 2.0</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a77">77</a></span>)
  293. </span>
  294. </div>
  295. <!-- ========== Info from phpDoc block ========= -->
  296. <ul class="tags">
  297. <li><span class="field">access:</span> protected</li>
  298. </ul>
  299. </div>
  300. <a name="var$_backoffLimit" id="$_backoffLimit"><!-- --></A>
  301. <div class="oddrow">
  302. <div class="var-header">
  303. <span class="var-title">
  304. <span class="var-type">mixed</span>
  305. <span class="var-name">$_backoffLimit</span>
  306. = <span class="var-default"> 600</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a76">76</a></span>)
  307. </span>
  308. </div>
  309. <!-- ========== Info from phpDoc block ========= -->
  310. <ul class="tags">
  311. <li><span class="field">access:</span> protected</li>
  312. </ul>
  313. </div>
  314. <a name="var$_createDocuments" id="$_createDocuments"><!-- --></A>
  315. <div class="evenrow">
  316. <div class="var-header">
  317. <span class="var-title">
  318. <span class="var-type">mixed</span>
  319. <span class="var-name">$_createDocuments</span>
  320. = <span class="var-default"> true</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a63">63</a></span>)
  321. </span>
  322. </div>
  323. <!-- ========== Info from phpDoc block ========= -->
  324. <ul class="tags">
  325. <li><span class="field">access:</span> protected</li>
  326. </ul>
  327. </div>
  328. <a name="var$_currentReadService" id="$_currentReadService"><!-- --></A>
  329. <div class="oddrow">
  330. <div class="var-header">
  331. <span class="var-title">
  332. <span class="var-type">mixed</span>
  333. <span class="var-name">$_currentReadService</span>
  334. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a68">68</a></span>)
  335. </span>
  336. </div>
  337. <!-- ========== Info from phpDoc block ========= -->
  338. <ul class="tags">
  339. <li><span class="field">access:</span> protected</li>
  340. </ul>
  341. </div>
  342. <a name="var$_currentWriteService" id="$_currentWriteService"><!-- --></A>
  343. <div class="evenrow">
  344. <div class="var-header">
  345. <span class="var-title">
  346. <span class="var-type">mixed</span>
  347. <span class="var-name">$_currentWriteService</span>
  348. = <span class="var-default"> null</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a69">69</a></span>)
  349. </span>
  350. </div>
  351. <!-- ========== Info from phpDoc block ========= -->
  352. <ul class="tags">
  353. <li><span class="field">access:</span> protected</li>
  354. </ul>
  355. </div>
  356. <a name="var$_defaultBackoff" id="$_defaultBackoff"><!-- --></A>
  357. <div class="oddrow">
  358. <div class="var-header">
  359. <span class="var-title">
  360. <span class="var-type">mixed</span>
  361. <span class="var-name">$_defaultBackoff</span>
  362. = <span class="var-default"> 2.0</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a78">78</a></span>)
  363. </span>
  364. </div>
  365. <!-- ========== Info from phpDoc block ========= -->
  366. <ul class="tags">
  367. <li><span class="field">access:</span> protected</li>
  368. </ul>
  369. </div>
  370. <a name="var$_readableServices" id="$_readableServices"><!-- --></A>
  371. <div class="evenrow">
  372. <div class="var-header">
  373. <span class="var-title">
  374. <span class="var-type">mixed</span>
  375. <span class="var-name">$_readableServices</span>
  376. = <span class="var-default">array()</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a65">65</a></span>)
  377. </span>
  378. </div>
  379. <!-- ========== Info from phpDoc block ========= -->
  380. <ul class="tags">
  381. <li><span class="field">access:</span> protected</li>
  382. </ul>
  383. </div>
  384. <a name="var$_readPingTimeout" id="$_readPingTimeout"><!-- --></A>
  385. <div class="oddrow">
  386. <div class="var-header">
  387. <span class="var-title">
  388. <span class="var-type">mixed</span>
  389. <span class="var-name">$_readPingTimeout</span>
  390. = <span class="var-default"> 2</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a71">71</a></span>)
  391. </span>
  392. </div>
  393. <!-- ========== Info from phpDoc block ========= -->
  394. <ul class="tags">
  395. <li><span class="field">access:</span> protected</li>
  396. </ul>
  397. </div>
  398. <a name="var$_useBackoff" id="$_useBackoff"><!-- --></A>
  399. <div class="evenrow">
  400. <div class="var-header">
  401. <span class="var-title">
  402. <span class="var-type">mixed</span>
  403. <span class="var-name">$_useBackoff</span>
  404. = <span class="var-default"> false</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a75">75</a></span>)
  405. </span>
  406. </div>
  407. <!-- ========== Info from phpDoc block ========= -->
  408. <ul class="tags">
  409. <li><span class="field">access:</span> protected</li>
  410. </ul>
  411. </div>
  412. <a name="var$_writeableServices" id="$_writeableServices"><!-- --></A>
  413. <div class="oddrow">
  414. <div class="var-header">
  415. <span class="var-title">
  416. <span class="var-type">mixed</span>
  417. <span class="var-name">$_writeableServices</span>
  418. = <span class="var-default">array()</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a66">66</a></span>)
  419. </span>
  420. </div>
  421. <!-- ========== Info from phpDoc block ========= -->
  422. <ul class="tags">
  423. <li><span class="field">access:</span> protected</li>
  424. </ul>
  425. </div>
  426. <a name="var$_writePingTimeout" id="$_writePingTimeout"><!-- --></A>
  427. <div class="evenrow">
  428. <div class="var-header">
  429. <span class="var-title">
  430. <span class="var-type">mixed</span>
  431. <span class="var-name">$_writePingTimeout</span>
  432. = <span class="var-default"> 4</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a72">72</a></span>)
  433. </span>
  434. </div>
  435. <!-- ========== Info from phpDoc block ========= -->
  436. <ul class="tags">
  437. <li><span class="field">access:</span> protected</li>
  438. </ul>
  439. </div>
  440. </div>
  441. </div>
  442. <a name="sec-methods"></a>
  443. <div class="info-box">
  444. <div class="info-box-title">Methods</div>
  445. <div class="nav-bar">
  446. <a href="#sec-description">Description</a> |
  447. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  448. <a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
  449. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  450. </div>
  451. <div class="info-box-body">
  452. <A NAME='method_detail'></A>
  453. <a name="methodescape" id="escape"><!-- --></a>
  454. <div class="oddrow">
  455. <div class="method-header">
  456. <span class="method-title">static escape</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a88">88</a></span>)
  457. </div>
  458. <!-- ========== Info from phpDoc block ========= -->
  459. <p class="short-description">Escape a value for special query characters such as ':', '(', ')', '*', '?', etc.</p>
  460. <p class="description"><p>NOTE: inside a phrase fewer characters need escaped, use <a href="../../Apache/Solr/Apache_Solr_Service.html#methodescapePhrase">Apache_Solr_Service::escapePhrase()</a> instead</p></p>
  461. <ul class="tags">
  462. <li><span class="field">access:</span> public</li>
  463. </ul>
  464. <div class="method-signature">
  465. static <span class="method-result">string</span>
  466. <span class="method-name">
  467. escape
  468. </span>
  469. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  470. </div>
  471. <ul class="parameters">
  472. <li>
  473. <span class="var-type">string</span>
  474. <span class="var-name">$value</span> </li>
  475. </ul>
  476. </div>
  477. <a name="methodescapePhrase" id="escapePhrase"><!-- --></a>
  478. <div class="evenrow">
  479. <div class="method-header">
  480. <span class="method-title">static escapePhrase</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a99">99</a></span>)
  481. </div>
  482. <!-- ========== Info from phpDoc block ========= -->
  483. <p class="short-description">Escape a value meant to be contained in a phrase for special query characters</p>
  484. <ul class="tags">
  485. <li><span class="field">access:</span> public</li>
  486. </ul>
  487. <div class="method-signature">
  488. static <span class="method-result">string</span>
  489. <span class="method-name">
  490. escapePhrase
  491. </span>
  492. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  493. </div>
  494. <ul class="parameters">
  495. <li>
  496. <span class="var-type">string</span>
  497. <span class="var-name">$value</span> </li>
  498. </ul>
  499. </div>
  500. <a name="methodphrase" id="phrase"><!-- --></a>
  501. <div class="oddrow">
  502. <div class="method-header">
  503. <span class="method-title">static phrase</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a110">110</a></span>)
  504. </div>
  505. <!-- ========== Info from phpDoc block ========= -->
  506. <p class="short-description">Convenience function for creating phrase syntax from a value</p>
  507. <ul class="tags">
  508. <li><span class="field">access:</span> public</li>
  509. </ul>
  510. <div class="method-signature">
  511. static <span class="method-result">string</span>
  512. <span class="method-name">
  513. phrase
  514. </span>
  515. (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  516. </div>
  517. <ul class="parameters">
  518. <li>
  519. <span class="var-type">string</span>
  520. <span class="var-name">$value</span> </li>
  521. </ul>
  522. </div>
  523. <a name="method__construct" id="__construct"><!-- --></a>
  524. <div class="evenrow">
  525. <div class="method-header">
  526. <span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a121">121</a></span>)
  527. </div>
  528. <!-- ========== Info from phpDoc block ========= -->
  529. <p class="short-description">Constructor. Takes arrays of read and write service instances or descriptions</p>
  530. <ul class="tags">
  531. <li><span class="field">access:</span> public</li>
  532. </ul>
  533. <div class="method-signature">
  534. <span class="method-result">Apache_Solr_Service_Balancer</span>
  535. <span class="method-name">
  536. __construct
  537. </span>
  538. ([<span class="var-type">array</span>&nbsp;<span class="var-name">$readableServices</span> = <span class="var-default">array()</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$writeableServices</span> = <span class="var-default">array()</span>])
  539. </div>
  540. <ul class="parameters">
  541. <li>
  542. <span class="var-type">array</span>
  543. <span class="var-name">$readableServices</span> </li>
  544. <li>
  545. <span class="var-type">array</span>
  546. <span class="var-name">$writeableServices</span> </li>
  547. </ul>
  548. </div>
  549. <a name="methodadd" id="add"><!-- --></a>
  550. <div class="oddrow">
  551. <div class="method-header">
  552. <span class="method-title">add</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a491">491</a></span>)
  553. </div>
  554. <!-- ========== Info from phpDoc block ========= -->
  555. <p class="short-description">Raw Add Method. Takes a raw post body and sends it to the update service. Post body should be a complete and well formed &quot;add&quot; xml document.</p>
  556. <ul class="tags">
  557. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  558. <li><span class="field">access:</span> public</li>
  559. </ul>
  560. <div class="method-signature">
  561. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  562. <span class="method-name">
  563. add
  564. </span>
  565. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>)
  566. </div>
  567. <ul class="parameters">
  568. <li>
  569. <span class="var-type">string</span>
  570. <span class="var-name">$rawPost</span> </li>
  571. </ul>
  572. </div>
  573. <a name="methodaddDocument" id="addDocument"><!-- --></a>
  574. <div class="evenrow">
  575. <div class="method-header">
  576. <span class="method-title">addDocument</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a526">526</a></span>)
  577. </div>
  578. <!-- ========== Info from phpDoc block ========= -->
  579. <p class="short-description">Add a Solr Document to the index</p>
  580. <ul class="tags">
  581. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  582. <li><span class="field">access:</span> public</li>
  583. </ul>
  584. <div class="method-signature">
  585. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  586. <span class="method-name">
  587. addDocument
  588. </span>
  589. (<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>])
  590. </div>
  591. <ul class="parameters">
  592. <li>
  593. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
  594. <span class="var-name">$document</span> </li>
  595. <li>
  596. <span class="var-type">boolean</span>
  597. <span class="var-name">$allowDups</span> </li>
  598. <li>
  599. <span class="var-type">boolean</span>
  600. <span class="var-name">$overwritePending</span> </li>
  601. <li>
  602. <span class="var-type">boolean</span>
  603. <span class="var-name">$overwriteCommitted</span> </li>
  604. </ul>
  605. </div>
  606. <a name="methodaddDocuments" id="addDocuments"><!-- --></a>
  607. <div class="oddrow">
  608. <div class="method-header">
  609. <span class="method-title">addDocuments</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a561">561</a></span>)
  610. </div>
  611. <!-- ========== Info from phpDoc block ========= -->
  612. <p class="short-description">Add an array of Solr Documents to the index all at once</p>
  613. <ul class="tags">
  614. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  615. <li><span class="field">access:</span> public</li>
  616. </ul>
  617. <div class="method-signature">
  618. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  619. <span class="method-name">
  620. addDocuments
  621. </span>
  622. (<span class="var-type">array</span>&nbsp;<span class="var-name">$documents</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$allowDups</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwritePending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$overwriteCommitted</span> = <span class="var-default">true</span>])
  623. </div>
  624. <ul class="parameters">
  625. <li>
  626. <span class="var-type">array</span>
  627. <span class="var-name">$documents</span><span class="var-description">: Should be an array of Apache_Solr_Document instances</span> </li>
  628. <li>
  629. <span class="var-type">boolean</span>
  630. <span class="var-name">$allowDups</span> </li>
  631. <li>
  632. <span class="var-type">boolean</span>
  633. <span class="var-name">$overwritePending</span> </li>
  634. <li>
  635. <span class="var-type">boolean</span>
  636. <span class="var-name">$overwriteCommitted</span> </li>
  637. </ul>
  638. </div>
  639. <a name="methodaddReadService" id="addReadService"><!-- --></a>
  640. <div class="evenrow">
  641. <div class="method-header">
  642. <span class="method-title">addReadService</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a172">172</a></span>)
  643. </div>
  644. <!-- ========== Info from phpDoc block ========= -->
  645. <p class="short-description">Adds a service instance or service descriptor (if it is already not added)</p>
  646. <ul class="tags">
  647. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If service descriptor is not valid</li>
  648. <li><span class="field">access:</span> public</li>
  649. </ul>
  650. <div class="method-signature">
  651. <span class="method-result">void</span>
  652. <span class="method-name">
  653. addReadService
  654. </span>
  655. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$service</span>)
  656. </div>
  657. <ul class="parameters">
  658. <li>
  659. <span class="var-type">mixed</span>
  660. <span class="var-name">$service</span> </li>
  661. </ul>
  662. </div>
  663. <a name="methodaddWriteService" id="addWriteService"><!-- --></a>
  664. <div class="oddrow">
  665. <div class="method-header">
  666. <span class="method-title">addWriteService</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a240">240</a></span>)
  667. </div>
  668. <!-- ========== Info from phpDoc block ========= -->
  669. <p class="short-description">Adds a service instance or service descriptor (if it is already not added)</p>
  670. <ul class="tags">
  671. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If service descriptor is not valid</li>
  672. <li><span class="field">access:</span> public</li>
  673. </ul>
  674. <div class="method-signature">
  675. <span class="method-result">void</span>
  676. <span class="method-name">
  677. addWriteService
  678. </span>
  679. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$service</span>)
  680. </div>
  681. <ul class="parameters">
  682. <li>
  683. <span class="var-type">mixed</span>
  684. <span class="var-name">$service</span> </li>
  685. </ul>
  686. </div>
  687. <a name="methodcommit" id="commit"><!-- --></a>
  688. <div class="evenrow">
  689. <div class="method-header">
  690. <span class="method-title">commit</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a595">595</a></span>)
  691. </div>
  692. <!-- ========== Info from phpDoc block ========= -->
  693. <p class="short-description">Send a commit command. Will be synchronous unless both wait parameters are set to false.</p>
  694. <ul class="tags">
  695. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  696. <li><span class="field">access:</span> public</li>
  697. </ul>
  698. <div class="method-signature">
  699. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  700. <span class="method-name">
  701. commit
  702. </span>
  703. ([<span class="var-type"></span>&nbsp;<span class="var-name">$optimize</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  704. </div>
  705. <ul class="parameters">
  706. <li>
  707. <span class="var-type">boolean</span>
  708. <span class="var-name">$waitFlush</span> </li>
  709. <li>
  710. <span class="var-type">boolean</span>
  711. <span class="var-name">$waitSearcher</span> </li>
  712. <li>
  713. <span class="var-type"></span>
  714. <span class="var-name">$optimize</span> </li>
  715. <li>
  716. <span class="var-type"></span>
  717. <span class="var-name">$timeout</span> </li>
  718. </ul>
  719. </div>
  720. <a name="methoddelete" id="delete"><!-- --></a>
  721. <div class="oddrow">
  722. <div class="method-header">
  723. <span class="method-title">delete</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a629">629</a></span>)
  724. </div>
  725. <!-- ========== Info from phpDoc block ========= -->
  726. <p class="short-description">Raw Delete Method. Takes a raw post body and sends it to the update service. Body should be a complete and well formed &quot;delete&quot; xml document</p>
  727. <ul class="tags">
  728. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  729. <li><span class="field">access:</span> public</li>
  730. </ul>
  731. <div class="method-signature">
  732. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  733. <span class="method-name">
  734. delete
  735. </span>
  736. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawPost</span>, [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  737. </div>
  738. <ul class="parameters">
  739. <li>
  740. <span class="var-type">string</span>
  741. <span class="var-name">$rawPost</span> </li>
  742. <li>
  743. <span class="var-type">float</span>
  744. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)</span> </li>
  745. </ul>
  746. </div>
  747. <a name="methoddeleteById" id="deleteById"><!-- --></a>
  748. <div class="evenrow">
  749. <div class="method-header">
  750. <span class="method-title">deleteById</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a664">664</a></span>)
  751. </div>
  752. <!-- ========== Info from phpDoc block ========= -->
  753. <p class="short-description">Create a delete document based on document ID</p>
  754. <ul class="tags">
  755. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  756. <li><span class="field">access:</span> public</li>
  757. </ul>
  758. <div class="method-signature">
  759. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  760. <span class="method-name">
  761. deleteById
  762. </span>
  763. (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  764. </div>
  765. <ul class="parameters">
  766. <li>
  767. <span class="var-type">string</span>
  768. <span class="var-name">$id</span> </li>
  769. <li>
  770. <span class="var-type">boolean</span>
  771. <span class="var-name">$fromPending</span> </li>
  772. <li>
  773. <span class="var-type">boolean</span>
  774. <span class="var-name">$fromCommitted</span> </li>
  775. <li>
  776. <span class="var-type">float</span>
  777. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)</span> </li>
  778. </ul>
  779. </div>
  780. <a name="methoddeleteByMultipleIds" id="deleteByMultipleIds"><!-- --></a>
  781. <div class="oddrow">
  782. <div class="method-header">
  783. <span class="method-title">deleteByMultipleIds</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a699">699</a></span>)
  784. </div>
  785. <!-- ========== Info from phpDoc block ========= -->
  786. <p class="short-description">Create and post a delete document based on multiple document IDs.</p>
  787. <ul class="tags">
  788. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  789. <li><span class="field">access:</span> public</li>
  790. </ul>
  791. <div class="method-signature">
  792. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  793. <span class="method-name">
  794. deleteByMultipleIds
  795. </span>
  796. (<span class="var-type">array</span>&nbsp;<span class="var-name">$ids</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  797. </div>
  798. <ul class="parameters">
  799. <li>
  800. <span class="var-type">array</span>
  801. <span class="var-name">$ids</span><span class="var-description">: Expected to be utf-8 encoded strings</span> </li>
  802. <li>
  803. <span class="var-type">boolean</span>
  804. <span class="var-name">$fromPending</span> </li>
  805. <li>
  806. <span class="var-type">boolean</span>
  807. <span class="var-name">$fromCommitted</span> </li>
  808. <li>
  809. <span class="var-type">float</span>
  810. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)</span> </li>
  811. </ul>
  812. </div>
  813. <a name="methoddeleteByQuery" id="deleteByQuery"><!-- --></a>
  814. <div class="evenrow">
  815. <div class="method-header">
  816. <span class="method-title">deleteByQuery</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a734">734</a></span>)
  817. </div>
  818. <!-- ========== Info from phpDoc block ========= -->
  819. <p class="short-description">Create a delete document based on a query and submit it</p>
  820. <ul class="tags">
  821. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  822. <li><span class="field">access:</span> public</li>
  823. </ul>
  824. <div class="method-signature">
  825. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  826. <span class="method-name">
  827. deleteByQuery
  828. </span>
  829. (<span class="var-type">string</span>&nbsp;<span class="var-name">$rawQuery</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromPending</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$fromCommitted</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  830. </div>
  831. <ul class="parameters">
  832. <li>
  833. <span class="var-type">string</span>
  834. <span class="var-name">$rawQuery</span> </li>
  835. <li>
  836. <span class="var-type">boolean</span>
  837. <span class="var-name">$fromPending</span> </li>
  838. <li>
  839. <span class="var-type">boolean</span>
  840. <span class="var-name">$fromCommitted</span> </li>
  841. <li>
  842. <span class="var-type">float</span>
  843. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the delete operation on the server (otherwise, will throw a communication exception)</span> </li>
  844. </ul>
  845. </div>
  846. <a name="methodextract" id="extract"><!-- --></a>
  847. <div class="oddrow">
  848. <div class="method-header">
  849. <span class="method-title">extract</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a776">776</a></span>)
  850. </div>
  851. <!-- ========== Info from phpDoc block ========= -->
  852. <p class="short-description">Use Solr Cell to extract document contents. See <a href="http://wiki.apache.org/solr/ExtractingRequestHandler">http://wiki.apache.org/solr/ExtractingRequestHandler</a> for information on how to use Solr Cell and what parameters are available.</p>
  853. <p class="description"><p>NOTE: when passing an Apache_Solr_Document instance, field names and boosts will automatically be prepended by &quot;literal.&quot; and &quot;boost.&quot; as appropriate. Any keys from the $params array will NOT be treated this way. Any mappings from the document will overwrite key / value pairs in the params array if they have the same name (e.g. you pass a &quot;literal.id&quot; key and value in your $params array but you also pass in a document isntance with an &quot;id&quot; field&quot; - the document's value(s) will take precedence).</p></p>
  854. <ul class="tags">
  855. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException if $file, $params, or $document are invalid.</li>
  856. <li><span class="field">access:</span> public</li>
  857. </ul>
  858. <div class="method-signature">
  859. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  860. <span class="method-name">
  861. extract
  862. </span>
  863. (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  864. </div>
  865. <ul class="parameters">
  866. <li>
  867. <span class="var-type">string</span>
  868. <span class="var-name">$file</span><span class="var-description">: Path to file to extract data from</span> </li>
  869. <li>
  870. <span class="var-type">array</span>
  871. <span class="var-name">$params</span><span class="var-description">: optional array of key value pairs that will be sent with the post (see Solr Cell documentation)</span> </li>
  872. <li>
  873. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
  874. <span class="var-name">$document</span><span class="var-description">: optional document that will be used to generate post parameters (literal.* and boost.* params)</span> </li>
  875. <li>
  876. <span class="var-type">string</span>
  877. <span class="var-name">$mimetype</span><span class="var-description">: optional mimetype specification (for the file being extracted)</span> </li>
  878. </ul>
  879. </div>
  880. <a name="methodextractFromString" id="extractFromString"><!-- --></a>
  881. <div class="evenrow">
  882. <div class="method-header">
  883. <span class="method-title">extractFromString</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a820">820</a></span>)
  884. </div>
  885. <!-- ========== Info from phpDoc block ========= -->
  886. <p class="short-description">Use Solr Cell to extract document contents. See <a href="http://wiki.apache.org/solr/ExtractingRequestHandler">http://wiki.apache.org/solr/ExtractingRequestHandler</a> for information on how to use Solr Cell and what parameters are available.</p>
  887. <p class="description"><p>NOTE: when passing an Apache_Solr_Document instance, field names and boosts will automatically be prepended by &quot;literal.&quot; and &quot;boost.&quot; as appropriate. Any keys from the $params array will NOT be treated this way. Any mappings from the document will overwrite key / value pairs in the params array if they have the same name (e.g. you pass a &quot;literal.id&quot; key and value in your $params array but you also pass in a document isntance with an &quot;id&quot; field&quot; - the document's value(s) will take precedence).</p></p>
  888. <ul class="tags">
  889. <li><span class="field">todo:</span> Should be using multipart/form-data to post parameter values, but I could not get my implementation to work. Needs revisisted.</li>
  890. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException if $file, $params, or $document are invalid.</li>
  891. <li><span class="field">access:</span> public</li>
  892. </ul>
  893. <div class="method-signature">
  894. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  895. <span class="method-name">
  896. extractFromString
  897. </span>
  898. (<span class="var-type">string</span>&nbsp;<span class="var-name">$data</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>&nbsp;<span class="var-name">$document</span> = <span class="var-default">null</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$mimetype</span> = <span class="var-default">'application/octet-stream'</span>])
  899. </div>
  900. <ul class="parameters">
  901. <li>
  902. <span class="var-type">string</span>
  903. <span class="var-name">$data</span><span class="var-description">: Data that will be passed to Solr Cell</span> </li>
  904. <li>
  905. <span class="var-type">array</span>
  906. <span class="var-name">$params</span><span class="var-description">: optional array of key value pairs that will be sent with the post (see Solr Cell documentation)</span> </li>
  907. <li>
  908. <span class="var-type"><a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a></span>
  909. <span class="var-name">$document</span><span class="var-description">: optional document that will be used to generate post parameters (literal.* and boost.* params)</span> </li>
  910. <li>
  911. <span class="var-type">string</span>
  912. <span class="var-name">$mimetype</span><span class="var-description">: optional mimetype specification (for the file being extracted)</span> </li>
  913. </ul>
  914. </div>
  915. <a name="methodgetCreateDocuments" id="getCreateDocuments"><!-- --></a>
  916. <div class="oddrow">
  917. <div class="method-header">
  918. <span class="method-title">getCreateDocuments</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a477">477</a></span>)
  919. </div>
  920. <!-- ========== Info from phpDoc block ========= -->
  921. <p class="short-description">Get the current state of teh create documents flag.</p>
  922. <ul class="tags">
  923. <li><span class="field">access:</span> public</li>
  924. </ul>
  925. <div class="method-signature">
  926. <span class="method-result">boolean</span>
  927. <span class="method-name">
  928. getCreateDocuments
  929. </span>
  930. ()
  931. </div>
  932. </div>
  933. <a name="methodoptimize" id="optimize"><!-- --></a>
  934. <div class="evenrow">
  935. <div class="method-header">
  936. <span class="method-title">optimize</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a855">855</a></span>)
  937. </div>
  938. <!-- ========== Info from phpDoc block ========= -->
  939. <p class="short-description">Send an optimize command. Will be synchronous unless both wait parameters are set to false.</p>
  940. <ul class="tags">
  941. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  942. <li><span class="field">access:</span> public</li>
  943. </ul>
  944. <div class="method-signature">
  945. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  946. <span class="method-name">
  947. optimize
  948. </span>
  949. ([<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitFlush</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$waitSearcher</span> = <span class="var-default">true</span>], [<span class="var-type">float</span>&nbsp;<span class="var-name">$timeout</span> = <span class="var-default">3600</span>])
  950. </div>
  951. <ul class="parameters">
  952. <li>
  953. <span class="var-type">boolean</span>
  954. <span class="var-name">$waitFlush</span> </li>
  955. <li>
  956. <span class="var-type">boolean</span>
  957. <span class="var-name">$waitSearcher</span> </li>
  958. <li>
  959. <span class="var-type">float</span>
  960. <span class="var-name">$timeout</span><span class="var-description">: Maximum expected duration of the optimize operation on the server (otherwise, will throw a communication exception)</span> </li>
  961. </ul>
  962. </div>
  963. <a name="methodremoveReadService" id="removeReadService"><!-- --></a>
  964. <div class="oddrow">
  965. <div class="method-header">
  966. <span class="method-title">removeReadService</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a202">202</a></span>)
  967. </div>
  968. <!-- ========== Info from phpDoc block ========= -->
  969. <p class="short-description">Removes a service instance or descriptor from the available services</p>
  970. <ul class="tags">
  971. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If service descriptor is not valid</li>
  972. <li><span class="field">access:</span> public</li>
  973. </ul>
  974. <div class="method-signature">
  975. <span class="method-result">void</span>
  976. <span class="method-name">
  977. removeReadService
  978. </span>
  979. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$service</span>)
  980. </div>
  981. <ul class="parameters">
  982. <li>
  983. <span class="var-type">mixed</span>
  984. <span class="var-name">$service</span> </li>
  985. </ul>
  986. </div>
  987. <a name="methodremoveWriteService" id="removeWriteService"><!-- --></a>
  988. <div class="evenrow">
  989. <div class="method-header">
  990. <span class="method-title">removeWriteService</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a270">270</a></span>)
  991. </div>
  992. <!-- ========== Info from phpDoc block ========= -->
  993. <p class="short-description">Removes a service instance or descriptor from the available services</p>
  994. <ul class="tags">
  995. <li><span class="field">throws:</span> Apache_Solr_InvalidArgumentException If service descriptor is not valid</li>
  996. <li><span class="field">access:</span> public</li>
  997. </ul>
  998. <div class="method-signature">
  999. <span class="method-result">void</span>
  1000. <span class="method-name">
  1001. removeWriteService
  1002. </span>
  1003. (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$service</span>)
  1004. </div>
  1005. <ul class="parameters">
  1006. <li>
  1007. <span class="var-type">mixed</span>
  1008. <span class="var-name">$service</span> </li>
  1009. </ul>
  1010. </div>
  1011. <a name="methodsearch" id="search"><!-- --></a>
  1012. <div class="oddrow">
  1013. <div class="method-header">
  1014. <span class="method-title">search</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a891">891</a></span>)
  1015. </div>
  1016. <!-- ========== Info from phpDoc block ========= -->
  1017. <p class="short-description">Simple Search interface</p>
  1018. <ul class="tags">
  1019. <li><span class="field">throws:</span> Apache_Solr_HttpTransportException If an error occurs during the service call</li>
  1020. <li><span class="field">access:</span> public</li>
  1021. </ul>
  1022. <div class="method-signature">
  1023. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a></span>
  1024. <span class="method-name">
  1025. search
  1026. </span>
  1027. (<span class="var-type">string</span>&nbsp;<span class="var-name">$query</span>, [<span class="var-type">int</span>&nbsp;<span class="var-name">$offset</span> = <span class="var-default">0</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$limit</span> = <span class="var-default">10</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span> = <span class="var-default">Apache_Solr_Service::METHOD_GET</span>])
  1028. </div>
  1029. <ul class="parameters">
  1030. <li>
  1031. <span class="var-type">string</span>
  1032. <span class="var-name">$query</span><span class="var-description">: The raw query string</span> </li>
  1033. <li>
  1034. <span class="var-type">int</span>
  1035. <span class="var-name">$offset</span><span class="var-description">: The starting offset for result documents</span> </li>
  1036. <li>
  1037. <span class="var-type">int</span>
  1038. <span class="var-name">$limit</span><span class="var-description">: The maximum number of result documents to return</span> </li>
  1039. <li>
  1040. <span class="var-type">array</span>
  1041. <span class="var-name">$params</span><span class="var-description">: key / value pairs for query parameters, use arrays for multivalued parameters</span> </li>
  1042. <li>
  1043. <span class="var-type">string</span>
  1044. <span class="var-name">$method</span><span class="var-description">: The HTTP method (Apache_Solr_Service::METHOD_GET or Apache_Solr_Service::METHOD::POST)</span> </li>
  1045. </ul>
  1046. </div>
  1047. <a name="methodsetCreateDocuments" id="setCreateDocuments"><!-- --></a>
  1048. <div class="evenrow">
  1049. <div class="method-header">
  1050. <span class="method-title">setCreateDocuments</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a460">460</a></span>)
  1051. </div>
  1052. <!-- ========== Info from phpDoc block ========= -->
  1053. <p class="short-description">Set the create documents flag. This determines whether <a href="../../Apache/Solr/Apache_Solr_Response.html">Apache_Solr_Response</a> objects will parse the response and create <a href="../../Apache/Solr/Apache_Solr_Document.html">Apache_Solr_Document</a> instances in place.</p>
  1054. <ul class="tags">
  1055. <li><span class="field">access:</span> public</li>
  1056. </ul>
  1057. <div class="method-signature">
  1058. <span class="method-result">void</span>
  1059. <span class="method-name">
  1060. setCreateDocuments
  1061. </span>
  1062. (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$createDocuments</span>)
  1063. </div>
  1064. <ul class="parameters">
  1065. <li>
  1066. <span class="var-type">boolean</span>
  1067. <span class="var-name">$createDocuments</span> </li>
  1068. </ul>
  1069. </div>
  1070. <a name="methodsetReadPingTimeout" id="setReadPingTimeout"><!-- --></a>
  1071. <div class="oddrow">
  1072. <div class="method-header">
  1073. <span class="method-title">setReadPingTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a136">136</a></span>)
  1074. </div>
  1075. <!-- ========== Info from phpDoc block ========= -->
  1076. <ul class="tags">
  1077. <li><span class="field">access:</span> public</li>
  1078. </ul>
  1079. <div class="method-signature">
  1080. <span class="method-result">void</span>
  1081. <span class="method-name">
  1082. setReadPingTimeout
  1083. </span>
  1084. (<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span>)
  1085. </div>
  1086. <ul class="parameters">
  1087. <li>
  1088. <span class="var-type"></span>
  1089. <span class="var-name">$timeout</span> </li>
  1090. </ul>
  1091. </div>
  1092. <a name="methodsetUseBackoff" id="setUseBackoff"><!-- --></a>
  1093. <div class="evenrow">
  1094. <div class="method-header">
  1095. <span class="method-title">setUseBackoff</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a146">146</a></span>)
  1096. </div>
  1097. <!-- ========== Info from phpDoc block ========= -->
  1098. <ul class="tags">
  1099. <li><span class="field">access:</span> public</li>
  1100. </ul>
  1101. <div class="method-signature">
  1102. <span class="method-result">void</span>
  1103. <span class="method-name">
  1104. setUseBackoff
  1105. </span>
  1106. (<span class="var-type"></span>&nbsp;<span class="var-name">$enable</span>)
  1107. </div>
  1108. <ul class="parameters">
  1109. <li>
  1110. <span class="var-type"></span>
  1111. <span class="var-name">$enable</span> </li>
  1112. </ul>
  1113. </div>
  1114. <a name="methodsetWritePingTimeout" id="setWritePingTimeout"><!-- --></a>
  1115. <div class="oddrow">
  1116. <div class="method-header">
  1117. <span class="method-title">setWritePingTimeout</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a141">141</a></span>)
  1118. </div>
  1119. <!-- ========== Info from phpDoc block ========= -->
  1120. <ul class="tags">
  1121. <li><span class="field">access:</span> public</li>
  1122. </ul>
  1123. <div class="method-signature">
  1124. <span class="method-result">void</span>
  1125. <span class="method-name">
  1126. setWritePingTimeout
  1127. </span>
  1128. (<span class="var-type"></span>&nbsp;<span class="var-name">$timeout</span>)
  1129. </div>
  1130. <ul class="parameters">
  1131. <li>
  1132. <span class="var-type"></span>
  1133. <span class="var-name">$timeout</span> </li>
  1134. </ul>
  1135. </div>
  1136. <a name="method_getServiceId" id="_getServiceId"><!-- --></a>
  1137. <div class="evenrow">
  1138. <div class="method-header">
  1139. <span class="method-title">_getServiceId</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a159">159</a></span>)
  1140. </div>
  1141. <!-- ========== Info from phpDoc block ========= -->
  1142. <p class="short-description">Generates a service ID</p>
  1143. <ul class="tags">
  1144. <li><span class="field">access:</span> protected</li>
  1145. </ul>
  1146. <div class="method-signature">
  1147. <span class="method-result">string</span>
  1148. <span class="method-name">
  1149. _getServiceId
  1150. </span>
  1151. (<span class="var-type">string</span>&nbsp;<span class="var-name">$host</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$port</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>)
  1152. </div>
  1153. <ul class="parameters">
  1154. <li>
  1155. <span class="var-type">string</span>
  1156. <span class="var-name">$host</span> </li>
  1157. <li>
  1158. <span class="var-type">integer</span>
  1159. <span class="var-name">$port</span> </li>
  1160. <li>
  1161. <span class="var-type">string</span>
  1162. <span class="var-name">$path</span> </li>
  1163. </ul>
  1164. </div>
  1165. <a name="method_selectReadService" id="_selectReadService"><!-- --></a>
  1166. <div class="oddrow">
  1167. <div class="method-header">
  1168. <span class="method-title">_selectReadService</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a308">308</a></span>)
  1169. </div>
  1170. <!-- ========== Info from phpDoc block ========= -->
  1171. <p class="short-description">Iterate through available read services and select the first with a ping that satisfies configured timeout restrictions (or the default)</p>
  1172. <ul class="tags">
  1173. <li><span class="field">throws:</span> Apache_Solr_NoServiceAvailableException If there are no read services that meet requirements</li>
  1174. <li><span class="field">access:</span> protected</li>
  1175. </ul>
  1176. <div class="method-signature">
  1177. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Service.html">Apache_Solr_Service</a></span>
  1178. <span class="method-name">
  1179. _selectReadService
  1180. </span>
  1181. ([<span class="var-type"></span>&nbsp;<span class="var-name">$forceSelect</span> = <span class="var-default">false</span>])
  1182. </div>
  1183. <ul class="parameters">
  1184. <li>
  1185. <span class="var-type"></span>
  1186. <span class="var-name">$forceSelect</span> </li>
  1187. </ul>
  1188. </div>
  1189. <a name="method_selectWriteService" id="_selectWriteService"><!-- --></a>
  1190. <div class="evenrow">
  1191. <div class="method-header">
  1192. <span class="method-title">_selectWriteService</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a356">356</a></span>)
  1193. </div>
  1194. <!-- ========== Info from phpDoc block ========= -->
  1195. <p class="short-description">Iterate through available write services and select the first with a ping that satisfies configured timeout restrictions (or the default)</p>
  1196. <ul class="tags">
  1197. <li><span class="field">throws:</span> Apache_Solr_NoServiceAvailableException If there are no write services that meet requirements</li>
  1198. <li><span class="field">access:</span> protected</li>
  1199. </ul>
  1200. <div class="method-signature">
  1201. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Service.html">Apache_Solr_Service</a></span>
  1202. <span class="method-name">
  1203. _selectWriteService
  1204. </span>
  1205. ([<span class="var-type"></span>&nbsp;<span class="var-name">$forceSelect</span> = <span class="var-default">false</span>])
  1206. </div>
  1207. <ul class="parameters">
  1208. <li>
  1209. <span class="var-type"></span>
  1210. <span class="var-name">$forceSelect</span> </li>
  1211. </ul>
  1212. </div>
  1213. <a name="method_selectWriteServiceSafe" id="_selectWriteServiceSafe"><!-- --></a>
  1214. <div class="oddrow">
  1215. <div class="method-header">
  1216. <span class="method-title">_selectWriteServiceSafe</span> (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a412">412</a></span>)
  1217. </div>
  1218. <!-- ========== Info from phpDoc block ========= -->
  1219. <p class="short-description">Iterate through available write services and select the first with a ping</p>
  1220. <p class="description"><p>that satisfies configured timeout restrictions (or the default). The timeout period will increase until a connection is made or the limit is reached. This will allow for increased reliability with heavily loaded server(s).</p></p>
  1221. <ul class="tags">
  1222. <li><span class="field">throws:</span> Apache_Solr_NoServiceAvailableException If there are no write services that meet requirements</li>
  1223. <li><span class="field">access:</span> protected</li>
  1224. </ul>
  1225. <div class="method-signature">
  1226. <span class="method-result"><a href="../../Apache/Solr/Apache_Solr_Service.html">Apache_Solr_Service</a></span>
  1227. <span class="method-name">
  1228. _selectWriteServiceSafe
  1229. </span>
  1230. ([<span class="var-type"></span>&nbsp;<span class="var-name">$forceSelect</span> = <span class="var-default">false</span>])
  1231. </div>
  1232. <ul class="parameters">
  1233. <li>
  1234. <span class="var-type"></span>
  1235. <span class="var-name">$forceSelect</span> </li>
  1236. </ul>
  1237. </div>
  1238. </div>
  1239. </div>
  1240. <a name="sec-consts"></a>
  1241. <div class="info-box">
  1242. <div class="info-box-title">Class Constants</div>
  1243. <div class="nav-bar">
  1244. <a href="#sec-description">Description</a> |
  1245. <a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
  1246. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  1247. |
  1248. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  1249. </div>
  1250. <div class="info-box-body">
  1251. <a name="constSVN_ID" id="SVN_ID"><!-- --></A>
  1252. <div class="evenrow">
  1253. <div class="const-header">
  1254. <img src="../../media/images/Variable.png" />
  1255. <span class="const-title">
  1256. <span class="const-name">SVN_ID</span>
  1257. = <span class="const-default"> '$Id: Balancer.php 54 2011-02-04 16:29:18Z donovan.jimenez $'</span>
  1258. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a61">61</a></span>)
  1259. </span>
  1260. </div>
  1261. <!-- ========== Info from phpDoc block ========= -->
  1262. <p class="short-description">SVN ID meta data for this class</p>
  1263. </div>
  1264. <a name="constSVN_REVISION" id="SVN_REVISION"><!-- --></A>
  1265. <div class="oddrow">
  1266. <div class="const-header">
  1267. <img src="../../media/images/Variable.png" />
  1268. <span class="const-title">
  1269. <span class="const-name">SVN_REVISION</span>
  1270. = <span class="const-default"> '$Revision: 54 $'</span>
  1271. (line <span class="line-number"><a href="../../__filesource/fsource_Apache_Solr_ServiceBalancer.php.html#a56">56</a></span>)
  1272. </span>
  1273. </div>
  1274. <!-- ========== Info from phpDoc block ========= -->
  1275. <p class="short-description">SVN Revision meta data for this class</p>
  1276. </div>
  1277. </div>
  1278. </div>
  1279. <p class="notes" id="credit">
  1280. Documentation generated on Wed, 04 May 2011 11:01:10 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
  1281. </p>
  1282. </div></body>
  1283. </html>