You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kftpgrabber/kftpgrabber/src/queuegroup.h

105 lines
3.0 KiB

/*
* This file is part of the KFTPGrabber project
*
* Copyright (C) 2003-2006 by the KFTPGrabber developers
* Copyright (C) 2003-2006 Jernej Kos <kostko@jweb-network.net>
*
* 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; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* is provided AS IS, WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, and
* NON-INFRINGEMENT. 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, write to the Free Software
* Foundation, Inc., 51 Franklin Steet, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of portions of this program with the
* OpenSSL library under certain conditions as described in each
* individual source file, and distribute linked combinations
* including the two.
*
* You must obey the GNU General Public License in all respects
* for all of the code used other than OpenSSL. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you
* do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source
* files in the program, then also delete it here.
*/
#ifndef KFTPQUEUEQUEUEGROUP_H
#define KFTPQUEUEQUEUEGROUP_H
#include <ntqguardedptr.h>
#include <ntqptrlist.h>
namespace KFTPQueue {
class QueueObject;
class Transfer;
/**
* This class manages a group of child queue objects so they get
* executed in the proper order.
*
* Note that all child transfers that are grouped together must be
* part of the same session, otherwise unexpected behavior may
* ocurr.
*
* @author Jernej Kos
*/
class QueueGroup : public TQObject {
Q_OBJECT
public:
/**
* Class constructor.
*
* @param object The queue object to manage
*/
QueueGroup(QueueObject *object);
/**
* Reset the group.
*/
void reset();
/**
* Execute the next transfer in list.
*
* @return 1 if the transfer has been executed, 0 or -1 otherwise
*/
int executeNextTransfer();
public slots:
/**
* Increment the current iterator and call executeNextTransfer method.
*/
void incrementAndExecute();
private:
QueueObject *m_object;
TQPtrListIterator<QueueObject> m_childIterator;
TQGuardedPtr<Transfer> m_lastTransfer;
bool m_directories;
signals:
/**
* This signal gets emitted when there is nothing more to do in the
* queue.
*/
void done();
/**
* This signal gets emitted when the group processing is interrupted
* due to abort.
*/
void interrupted();
};
}
#endif