remotetrans.h

Go to the documentation of this file.

/******************************************************************************
 *
 * remotetrans.h -  class RemoteTransport: the base for all communication
 *          transport drivers
 *
 * $Id: remotetrans.h 3820 2020-10-24 20:27:30Z scribe $
 *
 * Copyright 2004-2013 CrossWire Bible Society (http://www.crosswire.org)
 *  CrossWire Bible Society
 *  P. O. Box 2528
 *  Tempe, AZ  85280-2528
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation version 2.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 */

#ifndef REMOTETRANS_H
#define REMOTETRANS_H

#include <vector>
#include <defs.h>
#include <swbuf.h>


SWORD_NAMESPACE_START

class SWDLLEXPORT StatusReporter {
public:
    virtual ~StatusReporter() {};
    virtual void preStatus(long totalBytes, long completedBytes, const char *message);

    SWDEPRECATED virtual void statusUpdate(double dtTotal, double dlNow);
    virtual void update(unsigned long totalBytes, unsigned long completedBytes);
};


class SWDLLEXPORT RemoteTransport {

protected:
    StatusReporter *statusReporter;
    bool passive;
    long timeoutMillis;
    bool term;
    bool unverifiedPeerAllowed;
    SWBuf host;
    SWBuf u;
    SWBuf p;

public:
    RemoteTransport(const char *host, StatusReporter *statusReporter = 0);
    virtual ~RemoteTransport();

    /***********
     * override this method in your real impl
     *
     * if destBuf then write to buffer instead of file
     * @return -1 operation error (e.g., resource not found); -2 connection error (e.g., connection timeout or login failure); -3 user requested termination
     */
    virtual char getURL(const char *destPath, const char *sourceURL, SWBuf *destBuf = 0);

    /***********
     * override this method in your real impl
     *
     * if sourceBuf then read from buffer instead of file
     * @return -1 operation error (e.g., permission denied); -2 connection error (e.g., connection timeout or login failure); -3 user requested termination
     */
    virtual char putURL(const char *destURL, const char *sourcePath, SWBuf *sourceBuf = 0);


    int copyDirectory(const char *urlPrefix, const char *dir, const char *dest, const char *suffix);

    virtual std::vector<struct DirEntry> getDirList(const char *dirURL);
    void setPassive(bool passive) { this->passive = passive; }
    void setTimeoutMillis(long timeoutMillis) { this->timeoutMillis = timeoutMillis; }
    long getTimeoutMillis() { return timeoutMillis; }
    bool isPassive() { return passive; }
    void setUser(const char *user) { u = user; }
    void setPasswd(const char *passwd) { p = passwd; }
    void setUnverifiedPeerAllowed(bool val) { this->unverifiedPeerAllowed = val; }
    bool isUnverifiedPeerAllowed() { return unverifiedPeerAllowed; }
    void terminate() { term = true; }
};


SWORD_NAMESPACE_END

#endif