1Net::SFTP::Foreign::ConUsstearntCso(n3t)ributed Perl DocNuemte:n:tSaFtTiPo:n:Foreign::Constants(3)
2
3
4

NAME

6       Net::SFTP::Foreign::Constants - Constant definitions for
7       Net::SFTP::Foreign
8

SYNOPSIS

10           use Net::SFTP::Foreign::Constants qw(:tag SSH2_FILEXFER_VERSION);
11           print "Protocol version is ", SSH2_FILEXFER_VERSION;
12

DESCRIPTION

14       Net::SFTP::Foreign::Constants provides a list of exportable SFTP
15       constants: for SFTP messages and commands, for file-open flags, for
16       status messages, etc. Constants can be exported individually, or in
17       sets identified by tag names.
18
19       Net::SFTP::Foreign::Constants provides values for all of the constants
20       listed in the SFTP protocol version 3 draft; the only thing to note is
21       that the constants are listed with the prefix "SSH2_" instead of
22       "SSH_". So, for example, to import the constant for the file-open
23       command, you would write:
24
25           use Net::SFTP::Foreign::Constants qw( SSH2_FXP_OPEN );
26

TAGS

28       As mentioned above, constants can either be imported individually or in
29       sets grouped by tag names. The tag names are:
30
31       :fxp
32           Imports all of the "SSH2_FXP_*" constants: these are the constants
33           used in the messaging protocol.
34
35       :flags
36           Imports all of the "SSH2_FXF_*" constants: these are constants used
37           as flags sent to the server when opening files.
38
39       :att
40           Imports all of the "SSH2_FILEXFER_ATTR_*" constants: these are the
41           constants used to construct the flag in the serialized attributes.
42           The flag describes what types of file attributes are listed in the
43           buffer.
44
45       :status
46           Imports all of the "SSH2_FX_*" constants: these are constants
47           returned from a server "SSH2_FXP_STATUS" message and indicate the
48           status of a particular operation.
49
50       :error
51           Imports all the "SFTP_ERR_*" constants used to represent high level
52           errors: "SFTP_ERR_LOCAL_ALREADY_EXISTS",
53           "SFTP_ERR_LOCAL_CHMOD_FAILED", "SFTP_ERR_LOCAL_OPEN_FAILED",
54           "SFTP_ERR_LOCAL_READ_ERROR", "SFTP_ERR_LOCAL_STAT_FAILED",
55           "SFTP_ERR_LOCAL_UTIME_FAILED", "SFTP_ERR_LOCAL_WRITE_FAILED",
56           "SFTP_ERR_REMOTE_BAD_PACKET_SEQUENCE",
57           "SFTP_ERR_REMOTE_BAD_PERMISSIONS", "SFTP_ERR_REMOTE_BAD_TIME",
58           "SFTP_ERR_REMOTE_BLOCK_TOO_SMALL", "SFTP_ERR_REMOTE_CLOSE_FAILED",
59           "SFTP_ERR_REMOTE_FSETSTAT_FAILED", "SFTP_ERR_REMOTE_FSTAT_FAILED",
60           "SFTP_ERR_REMOTE_LSTAT_FAILED", "SFTP_ERR_REMOTE_MKDIR_FAILED",
61           "SFTP_ERR_REMOTE_OPENDIR_FAILED", "SFTP_ERR_REMOTE_OPEN_FAILED",
62           "SFTP_ERR_REMOTE_READDIR_FAILED", "SFTP_ERR_REMOTE_READ_FAILED",
63           "SFTP_ERR_REMOTE_REALPATH_FAILED", "SFTP_ERR_REMOTE_REMOVE_FAILED",
64           "SFTP_ERR_REMOTE_RENAME_FAILED", "SFTP_ERR_REMOTE_RMDIR_FAILED",
65           "SFTP_ERR_REMOTE_READLINK_FAILED",
66           "SFTP_ERR_REMOTE_SYMLINK_FAILED", "SFTP_ERR_REMOTE_SETSTAT_FAILED",
67           "SFTP_ERR_REMOTE_STAT_FAILED", "SFTP_ERR_REMOTE_WRITE_FAILED" and
68           "SFTP_ERR_REMOTE_HARDLINK_FAILED".
69
70           Note: these constants are not defined on the SFTP draft.
71
72       :ext
73           Import all the "SSH2_FXE_*" constants: there are the constants
74           defined for usage with SFTP extensions.
75
76           Currently, these are supported: "SSH2_FXE_STATVFS_ST_RDONLY",
77           "SSH_FXE_STATVFS_ST_NOSUID".
78
79       There is one constant that does not fit into any of the tag sets:
80       "SSH2_FILEXFER_VERSION", which holds the value of the SFTP protocol
81       implemented by Net::SFTP::Foreign.
82

AUTHOR & COPYRIGHTS

84       Please see the Net::SFTP::Foreign manpage for author, copyright, and
85       license information.
86
87
88
89perl v5.32.0                      2020-07-28  Net::SFTP::Foreign::Constants(3)