Changeset 82723 in vbox for trunk/include/iprt

Timestamp:

Jan 13, 2020 10:26:27 AM (5 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

135661

Message:

IPRT/FTP: More protocol handling and callback work. bugref:9437

File:

• trunk/include/iprt/ftp.h (modified) (8 diffs)

trunk/include/iprt/ftp.h

@@ -31 +31 @@
 #endif
 
+#include <iprt/fs.h>
 #include <iprt/types.h>
 
@@ -130 +131 @@
     /** Not logged in. */
     RTFTPSERVER_REPLY_NOT_LOGGED_IN                  = 530,
+    /** Requested action not taken. */
+    RTFTPSERVER_REPLY_REQ_ACTION_NOT_TAKEN           = 550,
     /** The usual 32-bit hack. */
     RTFTPSERVER_REPLY_32BIT_HACK                     = 0x7fffffff
@@ -179 +182 @@
      *
      * @returns VBox status code.
+     * @param   pData           Pointer to generic callback data.
      * @param   pcszUser        User name.
      */
@@ -186 +190 @@
      *
      * @returns VBox status code.
+     * @param   pData           Pointer to generic callback data.
      * @param   pcszUser        User name to authenticate.
      * @param   pcszPassword    Password to authenticate with.
@@ -194 +199 @@
      *
      * @returns VBox status code.
-     * @param   pcszUser        User name which disconnected.
+     * @param   pData           Pointer to generic callback data.
      */
     DECLCALLBACKMEMBER(int,  pfnOnUserDisconnect)(PRTFTPCALLBACKDATA pData);
     /**
+     * Callback which gets invoked when the client wants to retrieve the size of a specific file.
+     *
+     * @returns VBox status code.
+     * @param   pData           Pointer to generic callback data.
+     * @param   pcszPath        Path of file to retrieve size for.
+     * @param   puSize          Where to store the file size on success.
+     */
+    DECLCALLBACKMEMBER(int,  pfnOnFileGetSize)(PRTFTPCALLBACKDATA pData, const char *pcszPath, uint64_t *puSize);
+    /**
+     * Callback which gets invoked when the client wants to retrieve information about a file.
+     *
+     * @param   pData           Pointer to generic callback data.
+     * @param   pcszPath        Path of file / directory to "stat". Optional. If NULL, the current directory will be used.
+     * @param   pFsObjInfo      Where to return the RTFSOBJINFO data on success.
+     * @returns VBox status code.
+     */
+    DECLCALLBACKMEMBER(int,  pfnOnFileStat)(PRTFTPCALLBACKDATA pData, const char *pcszPath, PRTFSOBJINFO pFsObjInfo);
+    /**
      * Callback which gets invoked when setting the current working directory.
      *
      * @returns VBox status code.
+     * @param   pData           Pointer to generic callback data.
      * @param   pcszCWD         Current working directory to set.
      */
@@ -208 +232 @@
      *
      * @returns VBox status code.
+     * @param   pData           Pointer to generic callback data.
      * @param   pszPWD          Where to store the current working directory.
      * @param   cbPWD           Size of buffer in bytes.
@@ -216 +241 @@
      *
      * @returns VBox status code.
+     * @param   pData           Pointer to generic callback data.
      */
     DECLCALLBACKMEMBER(int,  pfnOnPathUp)(PRTFTPCALLBACKDATA pData);
@@ -221 +247 @@
      * Callback which gets invoked when the client wants to list a directory or file.
      *
+     * @param   pData           Pointer to generic callback data.
      * @param   pcszPath        Path of file / directory to list. Optional. If NULL, the current directory will be listed.
      * @param   ppvData         Where to return the listing data. Must be free'd by the caller.