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
|
<!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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="classmysqlpp_1_1Option.html">Option</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classmysqlpp_1_1Option-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::Option Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Define abstract interface for all *Option subclasses.
<a href="classmysqlpp_1_1Option.html#details">More...</a></p>
<p><code>#include <<a class="el" href="options_8h_source.html">options.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mysqlpp::Option:</div>
<div class="dyncontent">
<div class="center"><img src="classmysqlpp_1_1Option__inherit__graph.png" border="0" usemap="#mysqlpp_1_1Option_inherit__map" alt="Inheritance graph"/></div>
<map name="mysqlpp_1_1Option_inherit__map" id="mysqlpp_1_1Option_inherit__map">
<area shape="rect" id="node2" href="classmysqlpp_1_1CompressOption.html" title="Enable data compression on the connection. " alt="" coords="198,601,375,628"/><area shape="rect" id="node3" href="classmysqlpp_1_1DataOption.html" title="Define abstract interface for all *Options that take a lone scalar as an argument. " alt="" coords="198,652,375,679"/><area shape="rect" id="node25" href="classmysqlpp_1_1GuessConnectionOption.html" title="Allow C API to guess what kind of connection to use. " alt="" coords="195,703,378,745"/><area shape="rect" id="node26" href="classmysqlpp_1_1NamedPipeOption.html" title="Suggest use of named pipes. " alt="" coords="194,769,379,796"/><area shape="rect" id="node27" href="classmysqlpp_1_1SslOption.html" title="Specialized option for handling SSL parameters. " alt="" coords="219,820,355,847"/><area shape="rect" id="node28" href="classmysqlpp_1_1UseEmbeddedConnectionOption.html" title="Connect to embedded server in preference to remote server. " alt="" coords="171,871,402,913"/><area shape="rect" id="node29" href="classmysqlpp_1_1UseRemoteConnectionOption.html" title="Connect to remote server in preference to embedded server. " alt="" coords="179,937,394,978"/><area shape="rect" id="node4" href="classmysqlpp_1_1ConnectTimeoutOption.html" title="Change Connection::connect() default timeout. " alt="" coords="453,5,667,46"/><area shape="rect" id="node5" href="classmysqlpp_1_1FoundRowsOption.html" title="Make Query::affected_rows() return number of matched rows. " alt="" coords="467,70,653,111"/><area shape="rect" id="node6" href="classmysqlpp_1_1IgnoreSpaceOption.html" title="Allow spaces after function names in queries. " alt="" coords="465,135,655,177"/><area shape="rect" id="node7" href="classmysqlpp_1_1InitCommandOption.html" title="Give SQL executed on connect. " alt="" coords="463,201,657,228"/><area shape="rect" id="node8" href="classmysqlpp_1_1InteractiveOption.html" title="Assert that this is an interactive program. " alt="" coords="471,253,649,294"/><area shape="rect" id="node9" href="classmysqlpp_1_1LocalFilesOption.html" title="Enable LOAD DATA LOCAL statement. " alt="" coords="472,318,648,359"/><area shape="rect" id="node10" href="classmysqlpp_1_1LocalInfileOption.html" title="Enable LOAD LOCAL INFILE statement. " alt="" coords="472,383,648,425"/><area shape="rect" id="node11" href="classmysqlpp_1_1MultiResultsOption.html" title="Enable multiple result sets in a reply. " alt="" coords="465,449,655,490"/><area shape="rect" id="node12" href="classmysqlpp_1_1MultiStatementsOption.html" title="Enable multiple queries in a request to the server. " alt="" coords="473,514,647,555"/><area shape="rect" id="node13" href="classmysqlpp_1_1NoSchemaOption.html" title="Disable db.tbl.col syntax in queries. " alt="" coords="469,579,651,621"/><area shape="rect" id="node14" href="classmysqlpp_1_1ReadDefaultFileOption.html" title="Override use of my.cnf. " alt="" coords="473,645,647,686"/><area shape="rect" id="node15" href="classmysqlpp_1_1ReadDefaultGroupOption.html" title="Override use of my.cnf. " alt="" coords="467,710,653,751"/><area shape="rect" id="node16" href="classmysqlpp_1_1ReadTimeoutOption.html" title="Set timeout for IPC data reads. " alt="" coords="463,775,657,817"/><area shape="rect" id="node17" href="classmysqlpp_1_1ReconnectOption.html" title="Enable automatic reconnection to server. " alt="" coords="470,841,650,882"/><area shape="rect" id="node18" href="classmysqlpp_1_1ReportDataTruncationOption.html" title="Set reporting of data truncation errors. " alt="" coords="457,906,663,947"/><area shape="rect" id="node19" href="classmysqlpp_1_1SecureAuthOption.html" title="Enforce use of secure authentication, refusing connection if not available. " alt="" coords="467,971,653,1013"/><area shape="rect" id="node20" href="classmysqlpp_1_1SetCharsetDirOption.html" title="Give path to charset definition files. " alt="" coords="460,1037,660,1064"/><area shape="rect" id="node21" href="classmysqlpp_1_1SetCharsetNameOption.html" title="Give name of default charset. " alt="" coords="451,1088,669,1115"/><area shape="rect" id="node22" href="classmysqlpp_1_1SetClientIpOption.html" title="Fake client IP address when connecting to embedded server. " alt="" coords="469,1139,651,1165"/><area shape="rect" id="node23" href="classmysqlpp_1_1SharedMemoryBaseNameOption.html" title="Set name of shmem segment for IPC. " alt="" coords="461,1190,659,1231"/><area shape="rect" id="node24" href="classmysqlpp_1_1WriteTimeoutOption.html" title="Set timeout for IPC data reads. " alt="" coords="463,1255,657,1297"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:af0c0e22b32d2ee489bc77d360ce74c8c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8c">Error</a> { <br/>
  <a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8ca428c375eef3714cefac2c2c10396c14c">err_NONE</a>,
<a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8ca8006fc8212a2393a084f26d7980b8707">err_api_limit</a>,
<a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8ca3b6c862bd1548d5f4c28b62df8e600c6">err_api_reject</a>,
<a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8cab6ee57a202c62afb4f66912137174973">err_connected</a>,
<br/>
  <a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8ca6d200a37429e238707384de5826cd270">err_disconnected</a>
<br/>
}</td></tr>
<tr class="memdesc:af0c0e22b32d2ee489bc77d360ce74c8c"><td class="mdescLeft"> </td><td class="mdescRight">Types of option setting errors we can diagnose. <a href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8c">More...</a><br/></td></tr>
<tr class="separator:af0c0e22b32d2ee489bc77d360ce74c8c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acf6f7585df2f41324516e45ad4856899"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf6f7585df2f41324516e45ad4856899"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#acf6f7585df2f41324516e45ad4856899">~Option</a> ()</td></tr>
<tr class="memdesc:acf6f7585df2f41324516e45ad4856899"><td class="mdescLeft"> </td><td class="mdescRight">Destroy object. <br/></td></tr>
<tr class="separator:acf6f7585df2f41324516e45ad4856899"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab783846ebf48b7c7319cc045cb0b1828"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab783846ebf48b7c7319cc045cb0b1828"></a>
virtual <a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8c">Error</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Option.html#ab783846ebf48b7c7319cc045cb0b1828">set</a> (<a class="el" href="classmysqlpp_1_1DBDriver.html">DBDriver</a> *dbd)=0</td></tr>
<tr class="memdesc:ab783846ebf48b7c7319cc045cb0b1828"><td class="mdescLeft"> </td><td class="mdescRight">Apply option. <br/></td></tr>
<tr class="separator:ab783846ebf48b7c7319cc045cb0b1828"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Define abstract interface for all *Option subclasses. </p>
<p>This is the base class for the mid-level interface classes that take arguments, plus the direct base for options that take no arguments. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="af0c0e22b32d2ee489bc77d360ce74c8c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classmysqlpp_1_1Option.html#af0c0e22b32d2ee489bc77d360ce74c8c">mysqlpp::Option::Error</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Types of option setting errors we can diagnose. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="af0c0e22b32d2ee489bc77d360ce74c8ca428c375eef3714cefac2c2c10396c14c"></a>err_NONE</em> </td><td class="fielddoc">
<p>option was set successfully </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="af0c0e22b32d2ee489bc77d360ce74c8ca8006fc8212a2393a084f26d7980b8707"></a>err_api_limit</em> </td><td class="fielddoc">
<p>option not supported by underlying C API </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="af0c0e22b32d2ee489bc77d360ce74c8ca3b6c862bd1548d5f4c28b62df8e600c6"></a>err_api_reject</em> </td><td class="fielddoc">
<p>underlying C API returned error when setting option </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="af0c0e22b32d2ee489bc77d360ce74c8cab6ee57a202c62afb4f66912137174973"></a>err_connected</em> </td><td class="fielddoc">
<p>can't set the given option while connected </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="af0c0e22b32d2ee489bc77d360ce74c8ca6d200a37429e238707384de5826cd270"></a>err_disconnected</em> </td><td class="fielddoc">
<p>can only set the given option while connected </p>
</td></tr>
</table>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="options_8h_source.html">options.h</a></li>
</ul>
</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>
|
