1Net::SFTP::Buffer(3)  User Contributed Perl Documentation Net::SFTP::Buffer(3)
2
3
4

NAME

6       Net::SFTP::Buffer - Read/write buffer class
7

SYNOPSIS

9           use Net::SFTP::Buffer;
10           my $buffer = Net::SFTP::Buffer->new;
11

DESCRIPTION

13       Net::SFTP::Buffer inherits from Net::SSH::Perl::Buffer to provide
14       read/write buffer functionality for SSH. SFTP buffers are exactly the
15       same as SSH buffers, with a couple of additions:
16
17       ·   64-bit integers
18
19           SFTP requires the use of 64-bit integers to represent very large
20           file sizes. In Net::SFTP::Buffer 64-bit integers are implemented as
21           Math::Pari objects.
22
23       ·   File attribute bundles
24
25           Attribute bundles are not strictly a simple data type--they are, in
26           fact, made up of smaller pieces, like 32-bit integers, 64-bit
27           integers, etc.--but for matters of convenience, it is easiest to
28           provide methods to directly serialize/deserialize attributes from
29           buffers.
30

USAGE

32       Usage of Net::SFTP::Buffer objects is exactly the same as usage of
33       Net::SSH::Perl::Buffer objects, with additions of the following methods
34       to support the above data types.
35
36   $buffer->get_int64
37       Extracts a 64-bit integer from $buffer and returns it as a Math::Pari
38       object.
39
40   $buffer->put_int64($int)
41       Serializes a 64-bit integer $int into the buffer $buffer; $int can be
42       either a Math::Pari object or a built-in Perl integer, if it is small
43       enough to fit into a Perl int.
44
45   $buffer->get_attributes
46       Uses Net::SFTP::Attributes to extract a list of file attributes from
47       $buffer, and returns a Net::SFTP::Attributes object containing those
48       file attributes.
49
50   $buffer->put_attributes($attrs)
51       Serializes a Net::SFTP::Attributes object $attrs into the buffer
52       $buffer.
53

AUTHOR & COPYRIGHTS

55       Please see the Net::SFTP manpage for author, copyright, and license
56       information.
57
58
59
60perl v5.28.1                      2017-06-27              Net::SFTP::Buffer(3)
Impressum