MySQL
8.3.0
Source Code Documentation
i_chain_element.h
Go to the documentation of this file.
1
/*
2
Copyright (c) 2015, 2023, Oracle and/or its affiliates.
3
4
This program is free software; you can redistribute it and/or modify
5
it under the terms of the GNU General Public License, version 2.0,
6
as published by the Free Software Foundation.
7
8
This program is also distributed with certain software (including
9
but not limited to OpenSSL) that is licensed under separate terms,
10
as designated in a particular file or component or in included license
11
documentation. The authors of MySQL hereby grant you an additional
12
permission to link the program and your derivative works with the
13
separately licensed software that they have included with MySQL.
14
15
This program is distributed in the hope that it will be useful,
16
but WITHOUT ANY WARRANTY; without even the implied warranty of
17
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
GNU General Public License, version 2.0, for more details.
19
20
You should have received a copy of the GNU General Public License
21
along with this program; if not, write to the Free Software
22
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23
*/
24
25
#ifndef I_CHAIN_ELEMENT_INCLUDED
26
#define I_CHAIN_ELEMENT_INCLUDED
27
28
#include "
client/dump/i_progress_reporter.h
"
29
#include "
my_inttypes.h
"
30
31
namespace
Mysql
{
32
namespace
Tools {
33
namespace
Dump {
34
35
class
Item_processing_data;
36
37
/**
38
Interface for all objects that can process data in any part of dump process.
39
*/
40
class
I_chain_element
:
public
virtual
I_progress_reporter
{
41
public
:
42
~I_chain_element
()
override
;
43
44
/**
45
Returns an application unique ID of this chain element object. This helps
46
progress watching with multiple parts of chain during all objects
47
processing.
48
*/
49
virtual
uint64
get_id
()
const
= 0;
50
51
protected
:
52
/**
53
This callback can be requested to be called by child for any object
54
processing. This will be called when the object processing has completed.
55
Note that this function may be called from multiple threads so all
56
implementations must be thread-safe.
57
*/
58
virtual
void
item_completion_in_child_callback
(
59
Item_processing_data
*item_processed) = 0;
60
};
61
62
}
// namespace Dump
63
}
// namespace Tools
64
}
// namespace Mysql
65
66
#endif
Mysql::Tools::Dump::I_chain_element
Interface for all objects that can process data in any part of dump process.
Definition:
i_chain_element.h:40
Mysql::Tools::Dump::I_chain_element::~I_chain_element
~I_chain_element() override
Mysql::Tools::Dump::I_chain_element::item_completion_in_child_callback
virtual void item_completion_in_child_callback(Item_processing_data *item_processed)=0
This callback can be requested to be called by child for any object processing.
Mysql::Tools::Dump::I_chain_element::get_id
virtual uint64 get_id() const =0
Returns an application unique ID of this chain element object.
Mysql::Tools::Dump::I_progress_reporter
Definition:
i_progress_reporter.h:34
Mysql::Tools::Dump::Item_processing_data
Data structure for objects that are processed in any chain.
Definition:
item_processing_data.h:42
i_progress_reporter.h
my_inttypes.h
Some integer typedefs for easier portability.
uint64
uint64_t uint64
Definition:
my_inttypes.h:68
Mysql
Definition:
abstract_connection_program.h:39
client
dump
i_chain_element.h
Generated by
1.9.2