1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
|
#ifndef SshFileTransferObject_h
#define SshFileTransferObject_h
/******************************************************************************
*
* Copyright (C) 2002 Hugo PEREIRA <mailto: hugo.pereira@free.fr>
*
* This 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; either version 2 of the License, or (at your option) any later
* version.
*
* This software 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.
*
* You should have received a copy of the GNU General Public License along with
* this program. If not, see <http://www.gnu.org/licenses/>.
*
*******************************************************************************/
#include "Counter.h"
#include <QAbstractSocket>
#include <QByteArray>
#include <QObject>
#include <QString>
#include <QIODevice>
namespace Ssh
{
class BaseSocket;
class FileTransferObject: public QObject, private Base::Counter<FileTransferObject>
{
Q_OBJECT
public:
//* constructor
explicit FileTransferObject( QObject*, QString );
//*@name modifiers
//@{
//* set file size (for writing to remote)
/** it must be called before calling ::connect */
void setFileSize( qint64 fileSize )
{ fileSize_ = fileSize; }
using QObject::connect;
//* connect to remote file
bool connect( void*, QIODevice::OpenMode );
//* read (remote to local)
bool fromRemote( void*, QString );
//* read (remote to local)
bool fromRemote( void*, QIODevice* );
//* write (local to remote)
bool toRemote( void*, QString );
//* write (local to remote)
bool toRemote( void*, QIODevice* );
//* wait for connected
/** warning, this method is blocking */
bool waitForConnected( int msecs = 30000 );
//* wait for transfered
/** warning, this method is blocking */
bool waitForCompleted( int msecs = 30000 );
//@}
//*@name accessors
//@{
//* file size
qint64 fileSize() const
{ return fileSize_; }
//* bytes written
qint64 bytesTransferred() const
{ return bytesTransferred_; }
//* connection state
enum State
{
Uninitialized = 0,
Connected = 1 << 0,
Completed = 1 << 1,
Failed = 1 << 2
};
Q_DECLARE_FLAGS( StateMask, State );
//* state
StateMask state() const
{ return state_; }
//* true when remote file socket is connected
bool isConnected() const
{ return state_&Connected; }
//* true when transfer is completed
bool isCompleted() const
{ return state_&Completed; }
//* true when transfer has failed
bool isFailed() const
{ return state_&Failed; }
//* error string
QString errorString() const
{ return error_; }
//@}
Q_SIGNALS:
//* transfer percentage
void transferred( qint64 size, qint64 transferred );
//* error message
void error( QString );
//* debug message
void debug( QString );
//* emited when transfer is completed
void completed();
//* emited when transfer has failed
void failed();
protected Q_SLOTS:
//* process error
void _processError( QAbstractSocket::SocketError );
//* mark as connected
void _setConnected();
//* prepare reading
void _prepareReading();
//* read from ssh socket
void _readFromSocket();
//* write to ssh socket
void _writeToSocket();
//* close source file, once reading is finished
void _closeSourceFile();
//* close socket
void _closeSocket();
private:
//* set completed
void _setCompleted()
{
if( !(state_ & Completed ) )
{
state_ |= Completed;
emit completed();
}
}
//* set failed
void _setFailed()
{
if( !(state_ & Failed) )
{
state_ |= StateMask(Failed|Completed);
emit failed();
}
}
//* destination
QString remoteFilename_;
//* file size
qint64 fileSize_ = 0;
//* bytes read
qint64 bytesTransferred_ = 0;
//* source file
QIODevice* localDevice_ = nullptr;
//* true if source device is owned by us
bool deviceOwned_ = false;
//* read socket
BaseSocket* sshSocket_ = nullptr;
//* state
StateMask state_ = Uninitialized;
//* error string
QString error_;
//* buffer
QByteArray buffer_;
//* max buffer size
qint64 maxSize_ = 16384;
};
}
Q_DECLARE_OPERATORS_FOR_FLAGS( Ssh::FileTransferObject::StateMask );
#endif
|