1Net::SFTP::Constants(3)User Contributed Perl DocumentatioNnet::SFTP::Constants(3)
2
3
4
6 Net::SFTP::Constants - Exportable SFTP constants
7
9 use Net::SFTP::Constants qw( :tag CONSTANT );
10 print "Constant value is ", CONSTANT;
11
13 Net::SFTP::Constants provides a list of exportable SFTP constants: for
14 SFTP messages and commands, for file-open flags, for status messages,
15 etc. Constants can be exported individually, or in sets identified by
16 tag names.
17
18 Net::SFTP::Constants provides values for all of the constants listed in
19 the SFTP protocol version 3 draft; the only thing to note is that the
20 constants are listed with the prefix SSH2 instead of SSH. So, for
21 example, to import the constant for the file-open command, you would
22 write:
23
24 use Net::SFTP::Constants qw( SSH2_FXP_OPEN );
25
27 As mentioned above, constants can either be imported individually or in
28 sets grouped by tag names. The tag names are:
29
30 · fxp
31
32 Imports all of the SSH2_FXP_* constants: these are the constants
33 used in the messaging protocol.
34
35 · flags
36
37 Imports all of the SSH2_FXF_* constants: these are constants used
38 as flags sent to the server when opening files.
39
40 · att
41
42 Imports all of the SSH2_FILEXFER_ATTR_* constants: these are the
43 constants used to construct the flag in the serialized attributes.
44 The flag describes what types of file attributes are listed in the
45 buffer.
46
47 · status
48
49 Imports all of the SSH2_FX_* constants: these are constants
50 returned from a server SSH2_FXP_STATUS message and indicate the
51 status of a particular operation.
52
53 There is one constant that does not fit into any of the tag sets:
54 SSH2_FILEXFER_VERSION, which holds the value of the SFTP protocol
55 implemented by Net::SFTP.
56
58 Please see the Net::SFTP manpage for author, copyright, and license
59 information.
60
61
62
63perl v5.32.0 2020-07-28 Net::SFTP::Constants(3)