Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Net::SFTP::Buffer(3)  User Contributed Perl Documentation Net::SFTP::Buffer(3)

NAME
       Net::SFTP::Buffer - Read/write buffer class

SYNOPSIS
	   use Net::SFTP::Buffer;
	   my $buffer =	Net::SFTP::Buffer->new;

DESCRIPTION
       Net::SFTP::Buffer inherits from Net::SSH::Perl::Buffer to provide
       read/write buffer functionality for SSH.	SFTP buffers are exactly the
       same as SSH buffers, with a couple of additions:

       o   64-bit integers

	   SFTP	requires the use of 64-bit integers to represent very large
	   file	sizes. In Net::SFTP::Buffer 64-bit integers are	implemented as
	   Math::Pari objects.

       o   File	attribute bundles

	   Attribute bundles are not strictly a	simple data type--they are, in
	   fact, made up of smaller pieces, like 32-bit	integers, 64-bit
	   integers, etc.--but for matters of convenience, it is easiest to
	   provide methods to directly serialize/deserialize attributes	from
	   buffers.

USAGE
       Usage of	Net::SFTP::Buffer objects is exactly the same as usage of
       Net::SSH::Perl::Buffer objects, with additions of the following methods
       to support the above data types.

   $buffer->get_int64
       Extracts	a 64-bit integer from $buffer and returns it as	a Math::Pari
       object.

   $buffer->put_int64($int)
       Serializes a 64-bit integer $int	into the buffer	$buffer; $int can be
       either a	Math::Pari object or a built-in	Perl integer, if it is small
       enough to fit into a Perl int.

   $buffer->get_attributes
       Uses Net::SFTP::Attributes to extract a list of file attributes from
       $buffer,	and returns a Net::SFTP::Attributes object containing those
       file attributes.

   $buffer->put_attributes($attrs)
       Serializes a Net::SFTP::Attributes object $attrs	into the buffer
       $buffer.

AUTHOR & COPYRIGHTS
       Please see the Net::SFTP	manpage	for author, copyright, and license
       information.

perl v5.32.1			  2017-06-27		  Net::SFTP::Buffer(3)

NAME | SYNOPSIS | DESCRIPTION | USAGE | AUTHOR & COPYRIGHTS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Net::SFTP::Buffer&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help