Net::FSP::File - An FSP file

Net-FSP documentation Contained in the Net-FSP distribution.

Index

Code Index:

NAME

Top

Net::FSP::File - An FSP file

VERSION

Top

This documentation refers to Net::FSP version 0.13

DESCRIPTION

Top

This class represents a file on the server.

METHODS

Top

This class inherits methods name, short_name, type, move, remove, size, time, link and accept from Net::FSP::Entry.

download($sink = $self->name)

This method downloads the file to $sink. $sink must either be an untainted filename, a filehandle or a callback function.

grab($sink = $self->name)

This method downloads the file and deletes it at when this is done. These actions are considered atomic by the server. Its argument works as in download.

cat()

This method downloads the file and returns it as a string. Using this on large files is not recommended.

upload($source)

This method overwrites a file on the server. $source must either be a filename, a filehandle or a callback function.

open($mode)

Open a file and return a filehandle. $mode must be either < or > for reading or writing respectively. Only one writing filehandle at a time may be opened, this is a protocol restriction.

AUTHOR

Top

Leon Timmermans, fawaka@gmail.com

LICENSE AND COPYRIGHT

Top

Copyright (c) 2005, 2008 Leon Timmermans. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Net-FSP documentation Contained in the Net-FSP distribution. 
package Net::FSP::File;

use strict;
use warnings;
use Net::FSP::Entry;
use base 'Net::FSP::Entry';
our $VERSION = $Net::FSP::VERSION;

sub download {
	my ($self, $sink) = @_;
	$sink = $self->{name} if not defined $sink;
	$self->{fsp}->download_file($self->{name}, $sink);
	return;
}

sub grab {
	my ($self, $sink) = @_;
	$sink = $self->{name} if not defined $sink;
	$self->{fsp}->grab_file($self->{name}, $sink);
	return;
}

sub upload {
	my ($self, $source) = @_;
	$self->{fsp}->grab_file($self->{name}, $source);
	return;
}

sub remove {
	my ($self) = @_;
	$self->{fsp}->delete_file($self->{name});
	return;
}

sub accept {
	my ($self, $visitor) = @_;
	$visitor->($self);
	return;
}

sub open {
	my ($self, $mode) = @_;
	$mode ||= '<';
	return $self->{fsp}->open_file($self->name, $mode);
}

1;

__END__