From: Christian Walde <walde.christian@googlemail.com>
Date: Mon, 12 Sep 2016 16:02:12 +0000 (+0200)
Subject: provide a trail of links towards the arguments passable to OR->connect
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=4e25b1fd82e526d9bd3d540faeb1ae7075c6d0a5;p=scpubgit%2FObject-Remote.git

provide a trail of links towards the arguments passable to OR->connect
---

diff --git a/lib/Object/Remote.pm b/lib/Object/Remote.pm
index c2324df..bcace31 100644
--- a/lib/Object/Remote.pm
+++ b/lib/Object/Remote.pm
@@ -112,6 +112,11 @@ to block until an asynchronous call completes or fails.
 
   my $conn = Object::Remote->connect('root@'); # connection over sudo
 
+  my $conn = Object::Remote->connect('root@', %args); # can take optional args
+
+Convenience method for calling L<Object::Remote::Connection/new_from_spec> in a
+L<Future>-compatible way.
+
 =head2 new::on
 
   my $eval = Eval::WithLexicals->new::on($conn);
diff --git a/lib/Object/Remote/Connection.pm b/lib/Object/Remote/Connection.pm
index bb1b260..d4dee82 100644
--- a/lib/Object/Remote/Connection.pm
+++ b/lib/Object/Remote/Connection.pm
@@ -528,6 +528,19 @@ Object::Remote::Connection - An underlying connection for L<Object::Remote>
 
 This is the class that supports connections to remote objects.
 
+=head1 METHODS
+
+=head2 new_from_spec
+
+  my $conn = Object::Remote::Connection->new_from_spec($spec, %args);
+
+Not intended for direct use, called by L<Object::Remote/connect> in a
+L<Future>-compatible way.
+
+Uses the spec to guess the appropiate Object::Remote::Connector::* class to use,
+instantiates it with the spec and any further arguments given, then calls
+C<connect> on it in a L<Future>-compatible way.
+
 =head1 SEE ALSO
 
 =over 4
diff --git a/lib/Object/Remote/Connector/INET.pm b/lib/Object/Remote/Connector/INET.pm
index eb0f188..09fb583 100644
--- a/lib/Object/Remote/Connector/INET.pm
+++ b/lib/Object/Remote/Connector/INET.pm
@@ -28,3 +28,16 @@ push @Object::Remote::Connection::Guess, sub {
 };
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connector::INET - A connector for INET sockets
+
+=head1 ARGUMENTS
+
+Inherits arguments from L<Object::Remote::Role::Connector> and provides the
+following:
+
+=head2 socket_path
+
+=cut
diff --git a/lib/Object/Remote/Connector/Local.pm b/lib/Object/Remote/Connector/Local.pm
index 6119e3f..6dfd9ab 100644
--- a/lib/Object/Remote/Connector/Local.pm
+++ b/lib/Object/Remote/Connector/Local.pm
@@ -16,3 +16,14 @@ push @Object::Remote::Connection::Guess, sub {
 };
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connector::Local - A connector for a local Perl process
+
+=head1 ARGUMENTS
+
+Inherits arguments from L<Object::Remote::Role::Connector::PerlInterpreter> and
+provides no own arguments.
+
+=cut
diff --git a/lib/Object/Remote/Connector/LocalSudo.pm b/lib/Object/Remote/Connector/LocalSudo.pm
index f3db7ea..886f5fe 100644
--- a/lib/Object/Remote/Connector/LocalSudo.pm
+++ b/lib/Object/Remote/Connector/LocalSudo.pm
@@ -97,3 +97,21 @@ push @Object::Remote::Connection::Guess, sub {
 };
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connector::LocalSudo - A connector for a local Perl process with
+sudo
+
+=head1 ARGUMENTS
+
+Inherits arguments from L<Object::Remote::Connector::Local> and provides the
+following:
+
+=head2 target_user
+
+=head2 password_callback
+
+=head2 sudo_perl_command
+
+=cut
diff --git a/lib/Object/Remote/Connector/SSH.pm b/lib/Object/Remote/Connector/SSH.pm
index 73bc2fc..ea27a37 100644
--- a/lib/Object/Remote/Connector/SSH.pm
+++ b/lib/Object/Remote/Connector/SSH.pm
@@ -42,3 +42,22 @@ push @Object::Remote::Connection::Guess, sub {
 };
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connector::SSH - A connector for SSH servers
+
+=head1 ARGUMENTS
+
+Inherits arguments from L<Object::Remote::Role::Connector::PerlInterpreter> and
+provides the following:
+
+=head2 ssh_to
+
+=head2 ssh_perl_command
+
+=head2 ssh_options
+
+=head2 ssh_command
+
+=cut
diff --git a/lib/Object/Remote/Connector/STDIO.pm b/lib/Object/Remote/Connector/STDIO.pm
index 69ba95d..908f8b3 100644
--- a/lib/Object/Remote/Connector/STDIO.pm
+++ b/lib/Object/Remote/Connector/STDIO.pm
@@ -24,3 +24,13 @@ sub connect {
 }
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connector::STDIO - ???
+
+=head1 ARGUMENTS
+
+Provides no arguments.
+
+=cut
diff --git a/lib/Object/Remote/Connector/UNIX.pm b/lib/Object/Remote/Connector/UNIX.pm
index 99e9a44..ca90dda 100644
--- a/lib/Object/Remote/Connector/UNIX.pm
+++ b/lib/Object/Remote/Connector/UNIX.pm
@@ -28,3 +28,16 @@ push @Object::Remote::Connection::Guess, sub {
 };
 
 1;
+
+=head1 NAME
+
+Object::Remote::Connector::UNIX - A connector for UNIX sockets
+
+=head1 ARGUMENTS
+
+Inherits arguments from L<Object::Remote::Role::Connector> and provides the
+following:
+
+=head2 socket_path
+
+=cut
diff --git a/lib/Object/Remote/Role/Connector.pm b/lib/Object/Remote/Role/Connector.pm
index 8ad06c2..4386a82 100644
--- a/lib/Object/Remote/Role/Connector.pm
+++ b/lib/Object/Remote/Role/Connector.pm
@@ -62,3 +62,13 @@ sub connect {
 }
 
 1;
+
+=head1 NAME
+
+Object::Remote::Role::Connector - Basic Future-compatible connector capability
+
+=head1 ARGUMENTS
+
+=head2 timeout
+
+=cut
diff --git a/lib/Object/Remote/Role/Connector/PerlInterpreter.pm b/lib/Object/Remote/Role/Connector/PerlInterpreter.pm
index 6a3093b..7dcbc6a 100644
--- a/lib/Object/Remote/Role/Connector/PerlInterpreter.pm
+++ b/lib/Object/Remote/Role/Connector/PerlInterpreter.pm
@@ -288,6 +288,9 @@ and is configurable via arguments passed to the constructor.
 
 =head1 ARGUMENTS
 
+Inherits arguments from L<Object::Remote::Role::Connector> and provides the
+following:
+
 =over 4
 
 =item perl_command