NAME

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

SYNOPSIS

use App::KGB::Client::ServerRef;
my $s = App::KGB::Client::ServerRef->new(
    {   uri      => "http://some.server:port/",
        password => 's3cr1t',
        timeout  => 5
    }
);

$s->send_changes( $client, $commit, $branch, $module, { extra => stuff } );

DESCRIPTION

App::KGB::Client::ServerRef is used in App::KGB::Client to refer to remote KGB server instances. It encapsulates sending change sets to the remote server, maintaining the SOAP protocol encapsulation and authentication to the remote KGB server.

CONSTRUCTOR

new

The usual constructor. Accepts a hashref of initialiers.

FIELDS

uri (mandatory)

The URI of the remote KGB server. Something like http://some.host:port/.

proxy

This is the SOAP proxy used to communicate with the server. If omitted, defaults to the value of uri field, with ?session=KGB appended.

password (mandatory)

Password, to be used for authentication to the remote KGB server.

timeout

Specifies the timeout for the SOAP transaction in seconds. Defaults to 15 seconds.

verbose

Be verbose about communicating with KGB server.

METHODS

send_changes (message parameters)

Transmits the change set and all data about it along with the necessary authentication hash. If error occures, an exception is thrown.

Message parameters are passed as arguments in the following order:

Client instance (App::KGB::Client)

Commit (an instance of App::KGB::Commit)

Branch

Module

Extra

This is a hash reference with additional parameters.