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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>MySQL++ Reference Manual</title>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MySQL++: mysqlpp::SslOption Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MySQL++
 <span id="projectnumber">3.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="classmysqlpp_1_1SslOption.html">SslOption</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classmysqlpp_1_1SslOption-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::SslOption Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Specialized option for handling SSL parameters.
<a href="classmysqlpp_1_1SslOption.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::SslOption:</div>
<div class="dyncontent">
<div class="center"><img src="classmysqlpp_1_1SslOption__inherit__graph.png" border="0" usemap="#mysqlpp_1_1SslOption_inherit__map" alt="Inheritance graph"/></div>
<map name="mysqlpp_1_1SslOption_inherit__map" id="mysqlpp_1_1SslOption_inherit__map">
<area shape="rect" title="Specialized option for handling SSL parameters." alt="" coords="5,79,142,104"/>
<area shape="rect" href="classmysqlpp_1_1Option.html" title="Define abstract interface for all *Option subclasses." alt="" coords="15,5,132,31"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for mysqlpp::SslOption:</div>
<div class="dyncontent">
<div class="center"><img src="classmysqlpp_1_1SslOption__coll__graph.png" border="0" usemap="#mysqlpp_1_1SslOption_coll__map" alt="Collaboration graph"/></div>
<map name="mysqlpp_1_1SslOption_coll__map" id="mysqlpp_1_1SslOption_coll__map">
<area shape="rect" title="Specialized option for handling SSL parameters." alt="" coords="5,79,142,104"/>
<area shape="rect" href="classmysqlpp_1_1Option.html" title="Define abstract interface for all *Option subclasses." alt="" coords="15,5,132,31"/>
</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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a84845e9568b894a8f6059fff47e6908d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1SslOption.html#a84845e9568b894a8f6059fff47e6908d">SslOption</a> (const char *key=0, const char *cert=0, const char *ca=0, const char *capath=0, const char *cipher=0)</td></tr>
<tr class="memdesc:a84845e9568b894a8f6059fff47e6908d"><td class="mdescLeft"> </td><td class="mdescRight">Create a set of SSL connection option parameters. <a href="#a84845e9568b894a8f6059fff47e6908d">More...</a><br /></td></tr>
<tr class="separator:a84845e9568b894a8f6059fff47e6908d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classmysqlpp_1_1Option"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmysqlpp_1_1Option')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classmysqlpp_1_1Option.html">mysqlpp::Option</a></td></tr>
<tr class="memitem:acf6f7585df2f41324516e45ad4856899 inherit pub_methods_classmysqlpp_1_1Option"><td class="memItemLeft" align="right" valign="top"><a 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 inherit pub_methods_classmysqlpp_1_1Option"><td class="mdescLeft"> </td><td class="mdescRight">Destroy object. <br /></td></tr>
<tr class="separator:acf6f7585df2f41324516e45ad4856899 inherit pub_methods_classmysqlpp_1_1Option"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_classmysqlpp_1_1Option"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classmysqlpp_1_1Option')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classmysqlpp_1_1Option.html">mysqlpp::Option</a></td></tr>
<tr class="memitem:af0c0e22b32d2ee489bc77d360ce74c8c inherit pub_types_classmysqlpp_1_1Option"><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 inherit pub_types_classmysqlpp_1_1Option"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Specialized option for handling SSL parameters. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a84845e9568b894a8f6059fff47e6908d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84845e9568b894a8f6059fff47e6908d">◆ </a></span>SslOption()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mysqlpp::SslOption::SslOption </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>key</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cert</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>ca</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>capath</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cipher</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a set of SSL connection option parameters. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>the pathname to the key file </td></tr>
<tr><td class="paramname">cert</td><td>the pathname to the certificate file </td></tr>
<tr><td class="paramname">ca</td><td>the pathname to the certificate authority file </td></tr>
<tr><td class="paramname">capath</td><td>directory that contains trusted SSL CA certificates in pem format. </td></tr>
<tr><td class="paramname">cipher</td><td>list of allowable ciphers to use</td></tr>
</table>
</dd>
</dl>
<p>This option replaces <code>Connection::enable_ssl()</code> from MySQL++ version 2. Now you can set this connection option just like any other. </p>
</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 Sun Jul 21 2019 05:32:21 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
|
