Scroll to navigation

App::KGB::Client::ServerRef(3pm) User Contributed Perl Documentation App::KGB::Client::ServerRef(3pm)

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, $protocol_ver, $commit, $branch, $module, { extra => stuff } );
    $s->relay_message( $client, $message, [ { opts } ] );

DESCRIPTION

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

CONSTRUCTOR

The usual constructor. Accepts a hashref of initialiers.

FIELDS

The URI of the remote KGB server. Something like "http://some.host:port/".
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, to be used for authentication to the remote KGB server.
Specifies the timeout for the SOAP transaction in seconds. Defaults to 15 seconds.
Be verbose about communicating with KGB server.
Perform all processing, but do not communicate with the server.

METHODS

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

Message parameters are passed as arguments in the following order:

Sends a message to the server for relaying.
Methods implementing different protocol versions
Helper method sending commit information via SOAP. Dies on any error or SOAP FAULT.
Helper method sending commit information via JSON-RPC. Dies on errors.
2020-11-03 perl v5.30.3