1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>MySQL++ Reference Manual</title>
<meta http-equiv="Content-type" content="text/html;charset=iso-8859-1">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="refman.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul></div>
<h1>options.h File Reference</h1>Declares the Option class hierarchy, used to implement connection options in Connection and DBDriver classes. <a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="common_8h-source.html">common.h</a>"</code><br>
<code>#include <deque></code><br>
<code>#include <string></code><br>
<p>
<a href="options_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><b>mysqlpp</b></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html">mysqlpp::Option</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Define abstract interface for all *Option subclasses. <a href="classmysqlpp_1_1Option.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1DataOption.html">mysqlpp::DataOption< T ></a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Define abstract interface for all *Options that take a lone scalar as an argument. <a href="classmysqlpp_1_1DataOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CompressOption.html">mysqlpp::CompressOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable data compression on the connection. <a href="classmysqlpp_1_1CompressOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ConnectTimeoutOption.html">mysqlpp::ConnectTimeoutOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Change <a class="el" href="classmysqlpp_1_1Connection.html#a8e2b54058f7ff7c480e34129a8ee212">Connection::connect()</a> default timeout. <a href="classmysqlpp_1_1ConnectTimeoutOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1FoundRowsOption.html">mysqlpp::FoundRowsOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Make <a class="el" href="classmysqlpp_1_1Query.html#80d0b71c5cb23f70ebc0d27f0ecc3adc">Query::affected_rows()</a> return number of matched rows. <a href="classmysqlpp_1_1FoundRowsOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1GuessConnectionOption.html">mysqlpp::GuessConnectionOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow C API to guess what kind of connection to use. <a href="classmysqlpp_1_1GuessConnectionOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1IgnoreSpaceOption.html">mysqlpp::IgnoreSpaceOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allow spaces after function names in queries. <a href="classmysqlpp_1_1IgnoreSpaceOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1InitCommandOption.html">mysqlpp::InitCommandOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Give SQL executed on connect. <a href="classmysqlpp_1_1InitCommandOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1InteractiveOption.html">mysqlpp::InteractiveOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Assert that this is an interactive program. <a href="classmysqlpp_1_1InteractiveOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1LocalFilesOption.html">mysqlpp::LocalFilesOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable LOAD DATA LOCAL statement. <a href="classmysqlpp_1_1LocalFilesOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1LocalInfileOption.html">mysqlpp::LocalInfileOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable LOAD LOCAL INFILE statement. <a href="classmysqlpp_1_1LocalInfileOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1MultiResultsOption.html">mysqlpp::MultiResultsOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable multiple result sets in a reply. <a href="classmysqlpp_1_1MultiResultsOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1MultiStatementsOption.html">mysqlpp::MultiStatementsOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable multiple queries in a request to the server. <a href="classmysqlpp_1_1MultiStatementsOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1NamedPipeOption.html">mysqlpp::NamedPipeOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Suggest use of named pipes. <a href="classmysqlpp_1_1NamedPipeOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1NoSchemaOption.html">mysqlpp::NoSchemaOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disable db.tbl.col syntax in queries. <a href="classmysqlpp_1_1NoSchemaOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ReadDefaultFileOption.html">mysqlpp::ReadDefaultFileOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Override use of my.cnf. <a href="classmysqlpp_1_1ReadDefaultFileOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ReadDefaultGroupOption.html">mysqlpp::ReadDefaultGroupOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Override use of my.cnf. <a href="classmysqlpp_1_1ReadDefaultGroupOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ReadTimeoutOption.html">mysqlpp::ReadTimeoutOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Set.html">Set</a> timeout for IPC data reads. <a href="classmysqlpp_1_1ReadTimeoutOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ReconnectOption.html">mysqlpp::ReconnectOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enable automatic reconnection to server. <a href="classmysqlpp_1_1ReconnectOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1ReportDataTruncationOption.html">mysqlpp::ReportDataTruncationOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Set.html">Set</a> reporting of data truncation errors. <a href="classmysqlpp_1_1ReportDataTruncationOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1SecureAuthOption.html">mysqlpp::SecureAuthOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Enforce use of secure authentication, refusing connection if not available. <a href="classmysqlpp_1_1SecureAuthOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1SetCharsetDirOption.html">mysqlpp::SetCharsetDirOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Give path to charset definition files. <a href="classmysqlpp_1_1SetCharsetDirOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1SetCharsetNameOption.html">mysqlpp::SetCharsetNameOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Give name of default charset. <a href="classmysqlpp_1_1SetCharsetNameOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1SetClientIpOption.html">mysqlpp::SetClientIpOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fake client IP address when connecting to embedded server. <a href="classmysqlpp_1_1SetClientIpOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1SharedMemoryBaseNameOption.html">mysqlpp::SharedMemoryBaseNameOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Set.html">Set</a> name of shmem segment for IPC. <a href="classmysqlpp_1_1SharedMemoryBaseNameOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1SslOption.html">mysqlpp::SslOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Specialized option for handling SSL parameters. <a href="classmysqlpp_1_1SslOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseEmbeddedConnectionOption.html">mysqlpp::UseEmbeddedConnectionOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect to embedded server in preference to remote server. <a href="classmysqlpp_1_1UseEmbeddedConnectionOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1UseRemoteConnectionOption.html">mysqlpp::UseRemoteConnectionOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect to remote server in preference to embedded server. <a href="classmysqlpp_1_1UseRemoteConnectionOption.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1WriteTimeoutOption.html">mysqlpp::WriteTimeoutOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Set.html">Set</a> timeout for IPC data reads. <a href="classmysqlpp_1_1WriteTimeoutOption.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d85ecc5f33b8cc440fec324f0a638e3a"></a><!-- doxytag: member="options.h::IntegerOption" ref="d85ecc5f33b8cc440fec324f0a638e3a" args="" -->
typedef DataOption< unsigned > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemysqlpp.html#d85ecc5f33b8cc440fec324f0a638e3a">mysqlpp::IntegerOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Option.html">Option</a> w/ int argument. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9b8af956539a775787583a269827d4b"></a><!-- doxytag: member="options.h::BooleanOption" ref="c9b8af956539a775787583a269827d4b" args="" -->
typedef DataOption< bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemysqlpp.html#c9b8af956539a775787583a269827d4b">mysqlpp::BooleanOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Option.html">Option</a> w/ bool argument. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="307e959b80e992078a2e61c8730a27f8"></a><!-- doxytag: member="options.h::StringOption" ref="307e959b80e992078a2e61c8730a27f8" args="" -->
typedef DataOption< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemysqlpp.html#307e959b80e992078a2e61c8730a27f8">mysqlpp::StringOption</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Option.html">Option</a> w/ string argument. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42aca90e097537c93980365712a534fe"></a><!-- doxytag: member="options.h::OptionList" ref="42aca90e097537c93980365712a534fe" args="" -->
typedef std::deque< Option * > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemysqlpp.html#42aca90e097537c93980365712a534fe">mysqlpp::OptionList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The data type of the list of connection options. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="679d140d3eb1e59e4513af4b639c63b2"></a><!-- doxytag: member="options.h::OptionListIt" ref="679d140d3eb1e59e4513af4b639c63b2" args="" -->
typedef OptionList::const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="namespacemysqlpp.html#679d140d3eb1e59e4513af4b639c63b2">mysqlpp::OptionListIt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Primary iterator type into List. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Declares the Option class hierarchy, used to implement connection options in Connection and DBDriver classes.
<p>
This is tied closely enough to DBDriver that there's a pure-OO argument that it should be declared as protected or private members within DBDriver. We do it outside DBDriver because there's so much of it. It'd overwhelm everything else that's going on in that class totally out of proprortion to the importance of options. <hr size="1"><address style="align: right;"><small>Generated on Wed Feb 4 14:42:56 2009 for MySQL++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
|
