====== getLoadBalancedConnection ======
~~NOTOC~~
<WRAP right box>
== Applies To ==
[[v5:loadbalancer:index|ADOdb Load Balancer]]

== Syntax ==
   int getLoadBalancedConnection(
         string $connectionType = 'write|readonly'
         )

</WRAP>
===== Description =====
The method ''getLoadBalancedConnection()'' returns the appropriate node number for the connection type, taking into account the connection type, the connection weight, whether connections are pinned and if there are any failed connection in any of the nodes.
---------------------------
<WRAP tip>
To ensure the accuracy of the response, you should have executed at least one statement against the load balancer connection
</WRAP>
In the following example, we have 4 nodes, 1 ''write'' and 3 ''readonly''
^Node^Type^Weight^
|0|write|1|
|1|readonly|50|
|2|readonly|30|
|3|readonly|40|

  * If we make a call to getReadOnlyConnection('write'), the return value is always 0  (zero)
  * If we make a call to getReadOnlyConnection('readonly'), the return value is 1
  * If we disconnect node 1 or the connection fails, the return value is 3