further detail OR->connect arguments, and document other bits

[scpubgit/Object-Remote.git] / lib / Object / Remote / Connection.pm

diff --git a/lib/Object/Remote/Connection.pm b/lib/Object/Remote/Connection.pm
index bb1b260..f2a90b8 100644 (file)
--- a/lib/Object/Remote/Connection.pm
+++ b/lib/Object/Remote/Connection.pm
@@ -526,7 +526,23 @@ Object::Remote::Connection - An underlying connection for L<Object::Remote>
 
 =head1 DESCRIPTION
 
-This is the class that supports connections to remote objects.
+This is the base class for connections in OR objects. Connections are present
+both in the local and remote parts of each OR pair, and handle the data
+processing for sending OR commands and responses as JSON via the appropiate
+connection mechanism.
+
+=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