src/globalsearch/queueinterfaces/remote.h

/**********************************************************************
  RemoteQueueInterface - Interface for running jobs on a remote cluster.

  Copyright (C) 2011 by David C. Lonie

  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 of the License.

  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 REMOTEQUEUEINTERFACE_H
#define REMOTEQUEUEINTERFACE_H

#ifdef ENABLE_SSH

#include <globalsearch/queueinterface.h>

namespace GlobalSearch {
  class SSHConnection;

  class RemoteQueueInterface : public QueueInterface
  {
    Q_OBJECT;

  public:
    explicit RemoteQueueInterface(OptBase *parent,
                                  const QString &settingFile = "");

    virtual ~RemoteQueueInterface();

  public slots:

    virtual bool writeFiles(Structure *s,
                            const QHash<QString, QString> &files) const;

    virtual bool startJob(Structure *s) =0;

    virtual bool stopJob(Structure *s) =0;

    virtual QueueInterface::QueueStatus getStatus(Structure *s) const =0;

    virtual bool prepareForStructureUpdate(Structure *s) const;

    virtual bool checkIfFileExists(Structure *s,
                                   const QString &filename,
                                   bool *exists);
    virtual bool fetchFile(Structure *s,
                           const QString &filename,
                           QString *contents) const;

    virtual bool grepFile(Structure *s,
                          const QString &matchText,
                          const QString &filename,
                          QStringList *matches = 0,
                          int *exitcode = 0,
                          const bool caseSensitive = true) const;

  protected:
    bool createRemoteDirectory(Structure *structure,
                               SSHConnection *ssh) const;

    bool cleanRemoteDirectory(Structure *structure,
                              SSHConnection *ssh) const;

    bool copyRemoteFilesToLocalCache(Structure *structure,
                                     SSHConnection *ssh) const;
  };
}

#endif // ENABLE_SSH
#endif // REMOTEQUEUEINTERFACE_H

---