File Coverage

blib/lib/URI/fasp.pm

Criterion	Covered	Total	%
statement	24	24	100.0
branch	4	4	100.0
condition			n/a
subroutine	8	8	100.0
pod	3	3	100.0
total	39	39	100.0

package URI::fasp;

use strict;
use warnings;
use base 'URI::ssh';

use URI::QueryParam;

our $VERSION = '0.01';

sub _init {  shift->SUPER::_init(@_); }
sub default_fasp_port { 33001 }

# Aspera uses "port" to denote the FASP port. To avoid conflicting with the URI method of the
# same name we call this method "fasp_port".
sub fasp_port
{
    my $self  = shift;
    if(@_) {
      $self->query_param('port', @_);
      return;
    }

    $self->query_param('port') or
    $self->default_fasp_port;
}

sub as_ssh
{
    my $self = shift;
    my $ssh = $self->clone;
    $ssh->scheme('ssh');
    $ssh->query(undef);
    $ssh;
}

1;

=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');
   print $fasp->port;			# 97001
   print $fasp->fasp_port;		# 33001
   print $fasp->query_param('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 a SSH session.

This class is a subclass of L<< C|URI >> and uses the L<< C >> mixin.

=head1 METHODS

=head2 C

Return a L<< C|URI >> representation of the instance's control connection

=head2 C

The port used by the control connection, defaults to C<22>

=head2 C

The port used by the data connection, defaults to L<< C|/default_fasp_port >>

=head2 C

The default port used by the data connection, C<33001>

=head1 SEE ALSO

L, L, 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.