MySQL 8.0.37
Source Code Documentation
standard_writer.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2015, 2024, 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 designed to work 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 either included with
14 the program or referenced in the documentation.
15
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License, version 2.0, for more details.
20
21 You should have received a copy of the GNU General Public License
22 along with this program; if not, write to the Free Software
23 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24*/
25
26#ifndef STANDARD_WRITER_INCLUDED
27#define STANDARD_WRITER_INCLUDED
28
29#include <functional>
30#include <string>
31
34#include "my_inttypes.h"
35
36namespace Mysql {
37namespace Tools {
38namespace Dump {
39
40/**
41 Writes formatted data to standard output or error stream.
42 */
44 public:
45 Standard_writer(std::function<bool(const Mysql::Tools::Base::Message_data &)>
46 *message_handler,
47 Simple_id_generator *object_id_generator);
48 bool init() override;
49 void append(const std::string &data_to_append) override;
50
51 // Fix "inherits ... via dominance" warnings
53 I_progress_watcher *new_progress_watcher) override {
55 }
56
57 // Fix "inherits ... via dominance" warnings
58 uint64 get_id() const override { return Abstract_chain_element::get_id(); }
59
60 protected:
61 // Fix "inherits ... via dominance" warnings
63 Item_processing_data *item_processed) override {
65 }
66};
67
68} // namespace Dump
69} // namespace Tools
70} // namespace Mysql
71
72#endif
Structure to represent message from server sent after executing query.
Definition: message_data.h:49
Definition: abstract_chain_element.h:45
void register_progress_watcher(I_progress_watcher *new_progress_watcher) override
Add new Progress Watcher to report to.
Definition: abstract_chain_element.h:58
uint64 get_id() const override
Returns an application unique ID of this chain element object.
Definition: abstract_chain_element.cc:36
void item_completion_in_child_callback(Item_processing_data *item_processed) override
This callback can be requested to be called by child for any object processing.
Definition: abstract_chain_element.cc:150
Definition: i_output_writer.h:37
Definition: i_progress_watcher.h:37
Data structure for objects that are processed in any chain.
Definition: item_processing_data.h:43
Definition: simple_id_generator.h:37
Writes formatted data to standard output or error stream.
Definition: standard_writer.h:43
Standard_writer(std::function< bool(const Mysql::Tools::Base::Message_data &)> *message_handler, Simple_id_generator *object_id_generator)
Definition: standard_writer.cc:36
void item_completion_in_child_callback(Item_processing_data *item_processed) override
This callback can be requested to be called by child for any object processing.
Definition: standard_writer.h:62
bool init() override
Initialize writer.
Definition: standard_writer.cc:42
uint64 get_id() const override
Returns an application unique ID of this chain element object.
Definition: standard_writer.h:58
void append(const std::string &data_to_append) override
Adds new block of data atomically to output.
Definition: standard_writer.cc:32
void register_progress_watcher(I_progress_watcher *new_progress_watcher) override
Add new Progress Watcher to report to.
Definition: standard_writer.h:52
Some integer typedefs for easier portability.
uint64_t uint64
Definition: my_inttypes.h:69
Definition: abstract_connection_program.h:38