.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "MR::IProto::Cluster 3pm"
.TH MR::IProto::Cluster 3pm "2020-07-21" "perl v5.30.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
MR::IProto::Cluster \- cluster of servers
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is used to implement balancing between several servers.
.SH "EXPORTED CONSTANTS"
.IX Header "EXPORTED CONSTANTS"
.IP "\s-1RR\s0" 4
.IX Item "RR"
Round robin algorithm
.IP "\s-1HASH\s0" 4
.IX Item "HASH"
Hashing algorithm using \s-1CRC32\s0
.IP "\s-1KETAMA\s0" 4
.IX Item "KETAMA"
Ketama algorithm
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.IP "balance" 4
.IX Item "balance"
Balancing algorithms.
Possible values are constants: \s-1RR, HASH, KETAMA.\s0
Or their string analogs: 'round\-robin', 'hash\-crc32', 'ketama'.
.IP "servers" 4
.IX Item "servers"
ArrayRef of MR::IProto::Cluster::Server.
.SH "PUBLIC METHODS"
.IX Header "PUBLIC METHODS"
.ie n .IP "server( $key? )" 4
.el .IP "server( \f(CW$key\fR? )" 4
.IX Item "server( $key? )"
Get server from balancing using \f(CW$key\fR.
.ie n .IP "timeout( $new? )" 4
.el .IP "timeout( \f(CW$new\fR? )" 4
.IX Item "timeout( $new? )"
Used to set \f(CW$new\fR timeout value to all servers.
If argument is skipped and timeout is equal for all servers then returns
it value, if timeout is different then returns undef.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
MR::IProto, MR::IProto::Cluster::Server.