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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
<!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">
</head>
<body>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">options.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Declares the Option class hierarchy, used to implement connection options in Connection and DBDriver classes.
<a href="#details">More...</a></p>
<div class="textblock"><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/>
</div>
<p><a href="options_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Change <a class="el" href="classmysqlpp_1_1Connection.html#aa8e2b54058f7ff7c480e34129a8ee212" title="Connect to database after object is created. ">Connection::connect()</a> default timeout. <a href="classmysqlpp_1_1ConnectTimeoutOption.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Make <a class="el" href="classmysqlpp_1_1Query.html#a80d0b71c5cb23f70ebc0d27f0ecc3adc" title="Return the number of rows affected by the last query. ">Query::affected_rows()</a> return number of matched rows. <a href="classmysqlpp_1_1FoundRowsOption.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Set.html" title="A special std::set derivative for holding MySQL data sets. ">Set</a> timeout for IPC data reads. <a href="classmysqlpp_1_1ReadTimeoutOption.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Set.html" title="A special std::set derivative for holding MySQL data sets. ">Set</a> reporting of data truncation errors. <a href="classmysqlpp_1_1ReportDataTruncationOption.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Set.html" title="A special std::set derivative for holding MySQL data sets. ">Set</a> name of shmem segment for IPC. <a href="classmysqlpp_1_1SharedMemoryBaseNameOption.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><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 class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" 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 class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Set.html" title="A special std::set derivative for holding MySQL data sets. ">Set</a> timeout for IPC data reads. <a href="classmysqlpp_1_1WriteTimeoutOption.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ad85ecc5f33b8cc440fec324f0a638e3a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad85ecc5f33b8cc440fec324f0a638e3a"></a>
typedef DataOption< unsigned > </td><td class="memItemRight" valign="bottom"><b>mysqlpp::IntegerOption</b></td></tr>
<tr class="memdesc:ad85ecc5f33b8cc440fec324f0a638e3a"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Option.html" title="Define abstract interface for all *Option subclasses. ">Option</a> w/ int argument. <br/></td></tr>
<tr class="separator:ad85ecc5f33b8cc440fec324f0a638e3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9b8af956539a775787583a269827d4b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9b8af956539a775787583a269827d4b"></a>
typedef DataOption< bool > </td><td class="memItemRight" valign="bottom"><b>mysqlpp::BooleanOption</b></td></tr>
<tr class="memdesc:ac9b8af956539a775787583a269827d4b"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Option.html" title="Define abstract interface for all *Option subclasses. ">Option</a> w/ bool argument. <br/></td></tr>
<tr class="separator:ac9b8af956539a775787583a269827d4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a307e959b80e992078a2e61c8730a27f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a307e959b80e992078a2e61c8730a27f8"></a>
typedef DataOption< std::string > </td><td class="memItemRight" valign="bottom"><b>mysqlpp::StringOption</b></td></tr>
<tr class="memdesc:a307e959b80e992078a2e61c8730a27f8"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classmysqlpp_1_1Option.html" title="Define abstract interface for all *Option subclasses. ">Option</a> w/ string argument. <br/></td></tr>
<tr class="separator:a307e959b80e992078a2e61c8730a27f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a42aca90e097537c93980365712a534fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a42aca90e097537c93980365712a534fe"></a>
typedef std::deque< Option * > </td><td class="memItemRight" valign="bottom"><b>mysqlpp::OptionList</b></td></tr>
<tr class="memdesc:a42aca90e097537c93980365712a534fe"><td class="mdescLeft"> </td><td class="mdescRight">The data type of the list of connection options. <br/></td></tr>
<tr class="separator:a42aca90e097537c93980365712a534fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a679d140d3eb1e59e4513af4b639c63b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a679d140d3eb1e59e4513af4b639c63b2"></a>
typedef OptionList::const_iterator </td><td class="memItemRight" valign="bottom"><b>mysqlpp::OptionListIt</b></td></tr>
<tr class="memdesc:a679d140d3eb1e59e4513af4b639c63b2"><td class="mdescLeft"> </td><td class="mdescRight">Primary iterator type into List. <br/></td></tr>
<tr class="separator:a679d140d3eb1e59e4513af4b639c63b2"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Declares the Option class hierarchy, used to implement connection options in Connection and DBDriver classes. </p>
<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. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 18 2015 18:55:03 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
|
