i_dump_task.h

Go to the documentation of this file.

/*
  Copyright (c) 2015, 2024, Oracle and/or its affiliates.
 
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License, version 2.0,
  as published by the Free Software Foundation.
 
  This program is designed to work with certain software (including
  but not limited to OpenSSL) that is licensed under separate terms,
  as designated in a particular file or component or in included license
  documentation.  The authors of MySQL hereby grant you an additional
  permission to link the program and your derivative works with the
  separately licensed software that they have either included with
  the program or referenced in the documentation.
 
  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, version 2.0, 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 St, Fifth Floor, Boston, MA 02110-1301  USA
*/
 
#ifndef I_DUMP_TASK_INCLUDED
#define I_DUMP_TASK_INCLUDED
 
#include "client/dump/i_data_object.h"
 
namespace Mysql {
namespace Tools {
namespace Dump {
 
/**
  Interface for all individual dump process tasks.
 */
class I_dump_task {
 public:
  virtual ~I_dump_task();
 
  virtual I_data_object *get_related_db_object() const = 0;
  /**
    Returns true if task was fully completed by all elements of chain.
   */
  virtual bool is_completed() const = 0;
  /**
    Sets task completed flag. Need to be called once main chain element
    receives completion report.
   */
  virtual void set_completed() = 0;
  /**
    Returns true if task can start processing, for example when all
    dependencies are met.
   */
  virtual bool can_be_executed() const = 0;
};
 
}  // namespace Dump
}  // namespace Tools
}  // namespace Mysql
 
#endif