1App::KGB::Client::ServeUrsReerf(C3o)ntributed Perl DocumAepnpt:a:tKiGoBn::Client::ServerRef(3)
2
3
4

NAME

6       App::KGB::Client::ServerRef - server instance in KGB client
7

SYNOPSIS

9           use App::KGB::Client::ServerRef;
10           my $s = App::KGB::Client::ServerRef->new(
11               {   uri      => "http://some.server:port/",
12                   password => 's3cr1t',
13                   timeout  => 5
14               }
15           );
16
17           $s->send_changes( $client, $protocol_ver, $commit, $branch, $module, { extra => stuff } );
18
19           $s->relay_message( $client, $message, [ { opts } ] );
20

DESCRIPTION

22       App::KGB::Client::ServerRef is used in App::KGB::Client to refer to
23       remote KGB server instances. It encapsulates sending requests to the
24       remote server, maintaining protocol encapsulation and authentication.
25

CONSTRUCTOR

27       new The usual constructor. Accepts a hashref of initialiers.
28

FIELDS

30       uri (mandatory)
31           The URI of the remote KGB server. Something like
32           "http://some.host:port/".
33
34       proxy
35           This is the SOAP proxy used to communicate with the server. If
36           omitted, defaults to the value of uri field, with "?session=KGB"
37           appended.
38
39       password (mandatory)
40           Password, to be used for authentication to the remote KGB server.
41
42       timeout
43           Specifies the timeout for the SOAP transaction in seconds. Defaults
44           to 15 seconds.
45
46       verbose
47           Be verbose about communicating with KGB server.
48
49       dry_run
50           Perform all processing, but do not communicate with the server.
51

METHODS

53       send_changes (message parameters)
54           Transmits the change set and all data about it along with the
55           necessary authentication hash. If an error occurs, an exception is
56           thrown.
57
58           Message parameters are passed as arguments in the following order:
59
60           Client instance (App::KGB::Client)
61           Protocol version (or 'auto')
62           Commit (an instance of App::KGB::Commit)
63           Branch
64           Module
65           Extra
66               This is a hash reference with additional parameters.
67
68       relay_message(client, message [, options hash ])
69           Sends a message to the server for relaying.
70
71       send_changes_v2($info) =item send_changes_v3($info) =item
72       send_changes_v4($info)
73           Methods implementing different protocol versions
74
75       send_changes_soap($message)
76           Helper method sending commit information via SOAP. Dies on any
77           error or SOAP FAULT.
78
79       send_changes_json($message)
80           Helper method sending commit information via JSON-RPC. Dies on
81           errors.
82
83
84
85perl v5.30.1                      2020-01-29    App::KGB::Client::ServerRef(3)
Impressum