FtpPollerUtil.qm.dox.h

// -*- mode: c++; indent-tabs-mode: nil -*-
 
/*  FtpPollerUtil.qm Copyright 2023 Qore Technologies, s.r.o.
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
*/
 
 
// make sure we have the required qore version
 
 
/*  Version History
    * 2019-10-16 v1.0: Alzhan Turlybekov <[email protected]>
*/
 
namespace FtpPoller {
class FtpPollerFileEventInfoDataType : public HashDataType {
 
public:
        const FieldDescriptions = {
            "name": "The name of the file, link, or directory",
            "size": "The size of the file in bytes",
            "mtime": "The last modified date/time of the file",
            "data": "The file's data if `local_dir` is not set; this will be a string unless the `binary` option is "
                "set to `True`, in which case this key is assigned to the file's binary data; when `local_dir` is "
                "set, file data is not included in the event but is rather transferred to the local directory",
            "filepath": "The remote filepath relative to SFTP root directory",
            "transfer_time": "The relative date/time value giving the time taken to transfer the file",
            "local_path": "Only included when `local_dir` is set; the target path for the file where the file will "
                "be moved to in the post event action",
        };
 
    constructor();
 
 
    string getDesc();
 
};
 
public hashdecl FtpPollerFileEventInfo {
    string name;
 
    int size;
 
    date mtime;
 
 
    data data;
 
    string filepath;
 
    date transfer_time;
 
    *string local_path;
};
};