MySQL 8.3.0
Source Code Documentation
i_options_provider.h
Go to the documentation of this file.
1/*
2 Copyright (c) 2014, 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_OPTIONS_PROVIDER_INCLUDED
26#define I_OPTIONS_PROVIDER_INCLUDED
27
28#include <vector>
29
31#include "my_getopt.h"
32
33namespace Mysql {
34namespace Tools {
35namespace Base {
36namespace Options {
37
38/**
39 Interface for basic options providers functionality.
40 */
42 public:
43 /**
44 Creates list of options provided by this provider.
45 @returns list of my_getopt internal option data structures.
46 */
47 virtual std::vector<my_option> generate_options() = 0;
48 /**
49 Callback to be called when command-line options parsing have finished.
50 */
51 virtual void options_parsed() = 0;
52 /**
53 Sets optional option changes listener to which all changes in all options
54 contained in this provider should be reported. This is used when this
55 provider is attached to another.
56 */
58 I_option_changed_listener *listener) = 0;
59};
60
61} // namespace Options
62} // namespace Base
63} // namespace Tools
64} // namespace Mysql
65
66#endif
Interface for listeners on some of option changes.
Definition: i_option_changed_listener.h:40
Interface for basic options providers functionality.
Definition: i_options_provider.h:41
virtual void set_option_changed_listener(I_option_changed_listener *listener)=0
Sets optional option changes listener to which all changes in all options contained in this provider ...
virtual std::vector< my_option > generate_options()=0
Creates list of options provided by this provider.
virtual void options_parsed()=0
Callback to be called when command-line options parsing have finished.
constexpr pos_type Options
Definition: http_request.h:260
Definition: abstract_connection_program.h:39