app::kgb::client::serverref(3pm) [debian man page]

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, $commit, $branch, $module );

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

perl v5.12.4							    2011-09-15					  App::KGB::Client::ServerRef(3pm)

App::KGB::Change(3pm)					User Contributed Perl Documentation				     App::KGB::Change(3pm)

NAME

       App::KGB::Change - a single file change

SYNOPSIS

	   my $c = App::KGB::Change->new(
	       { action => "M", prop_change => 1, path => "/there" } );

	   print $c;

	   my $c = App::KGB::Change->new("(M+)/there");

DESCRIPTION

       App::KGB::Change encapsulates a single path change from a given change set (or commit).

       App::KGB::Change overloads the "" operator in order to provide a default string representation of changes.

FIELDS

       action (mandatory)
	   The action performed on the item. Possible values are:

	   M   The path was modified.

	   A   The path was added.

	   D   The path was deleted.

	   R   The path was replaced.

       path (mandatory)
	   The path that was changed.

       prop_change
	   Boolean. Indicated that some properties of the path, not the content were changed.

CONSTRUCTOR

   new ( { initial values } )
       More-or-less standard constructor.

       It can take a hashref with keys all the field names (See ).

       Or, it can take a single string, which is de-composed into components.

       See  for examples.

METHODS

       as_string()
	   Return a string representation of the change. Used by the ""  overload. The resulting string is suitable for feeding the  constructor
	   if needed.

CLASS METHODS

       detect_common_dir("changes")
	   Given an arrayref of changes (instances of APP::KGB::Change), detects the longest path that is common to all of them. All the changes'
	   paths are trimmed from the common part.

	   Example:

	    foo/b
	    foo/x
	    foo/bar/a

	   would return 'foo' and the paths would be trimmed to

	    b
	    x
	    bar/a

perl v5.12.4							    2011-09-15						     App::KGB::Change(3pm)