File: classmysqlpp_1_1SslOption.html

package info (click to toggle)
mysql%2B%2B 3.1.0-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 11,640 kB
  • sloc: cpp: 35,569; sh: 3,113; makefile: 946; perl: 786
file content (114 lines) | stat: -rw-r--r-- 6,082 bytes parent folder | download
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
<!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&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<div class="nav">
<b>mysqlpp</b>::<a class="el" href="classmysqlpp_1_1SslOption.html">SslOption</a></div>
<h1>mysqlpp::SslOption Class Reference</h1><!-- doxytag: class="mysqlpp::SslOption" --><!-- doxytag: inherits="mysqlpp::Option" -->Specialized option for handling SSL parameters.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="options_8h-source.html">options.h</a>&gt;</code>
<p>
Inheritance diagram for mysqlpp::SslOption:<p><center><img src="classmysqlpp_1_1SslOption__inherit__graph.png" border="0" usemap="#mysqlpp_1_1SslOption__inherit__map" alt="Inheritance graph"></center>
<map name="mysqlpp_1_1SslOption__inherit__map">
<area href="classmysqlpp_1_1Option.html" shape="rect" coords="15,7,145,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for mysqlpp::SslOption:<p><center><img src="classmysqlpp_1_1SslOption__coll__graph.png" border="0" usemap="#mysqlpp_1_1SslOption__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1SslOption__coll__map">
<area href="classmysqlpp_1_1Option.html" shape="rect" coords="5,7,136,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1SslOption-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1SslOption.html#84845e9568b894a8f6059fff47e6908d">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><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a set of SSL connection option parameters.  <a href="#84845e9568b894a8f6059fff47e6908d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Specialized option for handling SSL parameters. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="84845e9568b894a8f6059fff47e6908d"></a><!-- doxytag: member="mysqlpp::SslOption::SslOption" ref="84845e9568b894a8f6059fff47e6908d" args="(const char *key=0, const char *cert=0, const char *ca=0, const char *capath=0, const char *cipher=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mysqlpp::SslOption::SslOption           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>key</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>cert</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>ca</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>capath</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>cipher</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create a set of SSL connection option parameters. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>key</em>&nbsp;</td><td>the pathname to the key file </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>cert</em>&nbsp;</td><td>the pathname to the certificate file </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>ca</em>&nbsp;</td><td>the pathname to the certificate authority file </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>capath</em>&nbsp;</td><td>directory that contains trusted SSL CA certificates in pem format. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>cipher</em>&nbsp;</td><td>list of allowable ciphers to use</td></tr>
  </table>
</dl>
This option replaces <code>Connection::enable_ssl()</code> from MySQL++ version 2. Now you can set this connection option just like any other. 
</div>
</div><p>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 3 11:59:12 2010 for MySQL++ by&nbsp;
<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>