Permalink
Browse files

added docs and a tad bit of cleaning

  • Loading branch information...
1 parent 7014447 commit 485b87e3a7b85c5b2b98dcfd8b01c847fa2030e4 sshaw committed Dec 11, 2011
Showing with 65 additions and 0 deletions.
  1. +1 −0 INSTALL.SKIP
  2. +64 −0 README.pod
View
@@ -0,0 +1 @@
+README.pod
View
@@ -0,0 +1,64 @@
+=pod
+
+=head1 NAME
+
+URI::fasp - URI handler for Aspera's FASP protocol
+
+=head1 SYNOPSIS
+
+ $fasp = URI->new('fasp://example.com:97001?port=33001&bwcap=25000');
+ $fasp->targetrate(10_000);
+
+ print $fasp->port; # 97001
+ print $fasp->fasp_port; # 33001
+ print $fasp->bwcap; # 25000
+ # ...
+ $ssh = $fasp->as_ssh; # URI::ssh
+ print $ssh->port; # 97001
+
+=head1 DESCRIPTION
+
+Aspera uses seperate control and a data connections. The control connection is an SSH session.
+This class is a subclass of L<< C<URI::ssh> >> and uses the L<< C<URI::QueryParam> >> mixin.
+
+=head1 METHODS
+
+=head2 C<as_ssh>
+
+L<< C<URI::ssh> >> representation of the instance's control connection
+
+=head2 C<default_fasp_port>
+
+The default FASP port is 33001
+
+=head2 C<fasp_port>
+
+Defaults to L<< C<default_fasp_port> >>
+
+=head2 C<bwcap>
+
+Bandwidth cap
+
+=head2 C<policy>
+
+Transfer policy
+
+=head2 C<httpport>
+
+Fallback HTTP port
+
+=head2 C<targetrate>
+
+Target transfer rate
+
+=head1 SEE ALSO
+
+L<URI>, L<URI::QueryParam>, http://asperasoft.com
+
+=head1 AUTHOR
+
+Skye Shaw (sshaw AT lucas.cis.temple.edu)
+
+=head1 LICENSE
+
+Copyright (c) 2011 Skye Shaw. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

0 comments on commit 485b87e

Please sign in to comment.