.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "App::KGB::Client::ServerRef 3pm"
.TH App::KGB::Client::ServerRef 3pm "2024-01-01" "perl v5.36.0" "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"
App::KGB::Client::ServerRef \- server instance in KGB client
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&    use App::KGB::Client::ServerRef;
\&    my $s = App::KGB::Client::ServerRef\->new(
\&        {   uri      => "http://some.server:port/",
\&            password => \*(Aqs3cr1t\*(Aq,
\&            timeout  => 5
\&        }
\&    );
\&
\&    $s\->send_changes( $client, $protocol_ver, $commit, $branch, $module, { extra => stuff } );
\&
\&    $s\->relay_message( $client, $message, [ { opts } ] );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBApp::KGB::Client::ServerRef\fR is used in App::KGB::Client to refer to
remote \s-1KGB\s0 server instances. It encapsulates sending requests to the remote
server, maintaining protocol encapsulation and authentication.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "new" 4
.IX Item "new"
The usual constructor. Accepts a hashref of initialiers.
.SH "FIELDS"
.IX Header "FIELDS"
.IP "\fBuri\fR (\fBmandatory\fR)" 4
.IX Item "uri (mandatory)"
The \s-1URI\s0 of the remote \s-1KGB\s0 server. Something like \f(CW\*(C`http://some.host:port/\*(C'\fR.
.IP "\fBproxy\fR" 4
.IX Item "proxy"
This is the \s-1SOAP\s0 proxy used to communicate with the server. If omitted,
defaults to the value of \fBuri\fR field, with \f(CW\*(C`?session=KGB\*(C'\fR appended.
.IP "\fBpassword\fR (\fBmandatory\fR)" 4
.IX Item "password (mandatory)"
Password, to be used for authentication to the remote \s-1KGB\s0 server.
.IP "\fBtimeout\fR" 4
.IX Item "timeout"
Specifies the timeout for the \s-1SOAP\s0 transaction in seconds. Defaults to 15
seconds.
.IP "\fBverbose\fR" 4
.IX Item "verbose"
Be verbose about communicating with \s-1KGB\s0 server.
.IP "\fBdry_run\fR" 4
.IX Item "dry_run"
Perform all processing, but do not communicate with the server.
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBsend_changes\fR (\fImessage parameters\fR)" 4
.IX Item "send_changes (message parameters)"
Transmits the change set and all data about it along with the necessary
authentication hash. If an error occurs, an exception is thrown.
.Sp
Message parameters are passed as arguments in the following order:
.RS 4
.IP "Client instance (App::KGB::Client)" 4
.IX Item "Client instance (App::KGB::Client)"
.PD 0
.IP "Protocol version (or 'auto')" 4
.IX Item "Protocol version (or 'auto')"
.IP "Commit (an instance of App::KGB::Commit)" 4
.IX Item "Commit (an instance of App::KGB::Commit)"
.IP "Branch" 4
.IX Item "Branch"
.IP "Module" 4
.IX Item "Module"
.IP "Extra" 4
.IX Item "Extra"
.PD
This is a hash reference with additional parameters.
.RE
.RS 4
.RE
.IP "\fBrelay_message\fR(\fIclient\fR, \fImessage\fR [, \fIoptions hash\fR ])" 4
.IX Item "relay_message(client, message [, options hash ])"
Sends a message to the server for relaying.
.IP "send_changes_v2($info) =item send_changes_v3($info) =item send_changes_v4($info)" 4
.IX Item "send_changes_v2($info) =item send_changes_v3($info) =item send_changes_v4($info)"
Methods implementing different protocol versions
.IP "send_changes_soap($message)" 4
.IX Item "send_changes_soap($message)"
Helper method sending commit information via \s-1SOAP.\s0 Dies on any error or \s-1SOAP
FAULT.\s0
.IP "send_changes_json($message)" 4
.IX Item "send_changes_json($message)"
Helper method sending commit information via JSON-RPC. Dies on errors.