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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
|
<!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 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 List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<b>mysqlpp</b>::<a class="el" href="classmysqlpp_1_1TCPConnection.html">TCPConnection</a></div>
<h1>mysqlpp::TCPConnection Class Reference</h1><!-- doxytag: class="mysqlpp::TCPConnection" --><!-- doxytag: inherits="mysqlpp::Connection" -->Specialization of <code><a class="el" href="classmysqlpp_1_1Connection.html">Connection</a></code> for TCP/IP.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="tcp__connection_8h-source.html">tcp_connection.h</a>></code>
<p>
Inheritance diagram for mysqlpp::TCPConnection:<p><center><img src="classmysqlpp_1_1TCPConnection__inherit__graph.png" border="0" usemap="#mysqlpp_1_1TCPConnection__inherit__map" alt="Inheritance graph"></center>
<map name="mysqlpp_1_1TCPConnection__inherit__map">
<area href="classmysqlpp_1_1Connection.html" shape="rect" coords="32,82,192,106" alt="">
<area href="classmysqlpp_1_1OptionalExceptions.html" shape="rect" coords="5,7,219,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for mysqlpp::TCPConnection:<p><center><img src="classmysqlpp_1_1TCPConnection__coll__graph.png" border="0" usemap="#mysqlpp_1_1TCPConnection__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1TCPConnection__coll__map">
<area href="classmysqlpp_1_1Connection.html" shape="rect" coords="192,97,352,121" alt="">
<area href="classmysqlpp_1_1OptionalExceptions.html" shape="rect" coords="5,7,219,31" alt="">
<area href="classmysqlpp_1_1DBDriver.html" shape="rect" coords="333,7,480,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1TCPConnection-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"><a class="anchor" name="75cbc21607ac3f1998e11ea58faad534"></a><!-- doxytag: member="mysqlpp::TCPConnection::TCPConnection" ref="75cbc21607ac3f1998e11ea58faad534" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1TCPConnection.html#75cbc21607ac3f1998e11ea58faad534">TCPConnection</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create object without connecting it to the MySQL server. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1TCPConnection.html#3712f8d8ee8f4521f733d410fb2ab6c8">TCPConnection</a> (const char *addr, const char *db=0, const char *user=0, const char *password=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create object and connect to database server over TCP/IP in one step. <a href="#3712f8d8ee8f4521f733d410fb2ab6c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1TCPConnection.html#f19b05063295b93feae5de92caad693c">TCPConnection</a> (const <a class="el" href="classmysqlpp_1_1TCPConnection.html">TCPConnection</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Establish a new connection using the same parameters as an existing connection. <a href="#f19b05063295b93feae5de92caad693c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cb3ac928977f621b89c14d6690c0d28c"></a><!-- doxytag: member="mysqlpp::TCPConnection::~TCPConnection" ref="cb3ac928977f621b89c14d6690c0d28c" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1TCPConnection.html#cb3ac928977f621b89c14d6690c0d28c">~TCPConnection</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1TCPConnection.html#d111bd8e49a43b3ab4972d67459efaa5">connect</a> (const char *addr=0, const char *db=0, const char *user=0, const char *password=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Connect to database after object is created. <a href="#d111bd8e49a43b3ab4972d67459efaa5"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1TCPConnection.html#5726d3cf9dbd843686dcee1fe0899595">parse_address</a> (std::string &addr, unsigned int &port, std::string &error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Break the given TCP/IP address up into a separate address and port form. <a href="#5726d3cf9dbd843686dcee1fe0899595"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Specialization of <code><a class="el" href="classmysqlpp_1_1Connection.html">Connection</a></code> for TCP/IP.
<p>
This class just simplifies the connection creation interface of <code><a class="el" href="classmysqlpp_1_1Connection.html">Connection</a></code>. It does not add new functionality.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3712f8d8ee8f4521f733d410fb2ab6c8"></a><!-- doxytag: member="mysqlpp::TCPConnection::TCPConnection" ref="3712f8d8ee8f4521f733d410fb2ab6c8" args="(const char *addr, const char *db=0, const char *user=0, const char *password=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::TCPConnection::TCPConnection </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>db</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>user</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>password</em> = <code>0</code></td><td> </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 object and connect to database server over TCP/IP in one step.
<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>addr</em> </td><td>TCP/IP address of server, in either dotted quad form or as a host or domain name; may be followed by a colon and a port number or service name to override default port </td></tr>
<tr><td valign="top"></td><td valign="top"><em>db</em> </td><td>name of database to use </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user</em> </td><td>user name to log in under, or 0 to use the user name the program is running under </td></tr>
<tr><td valign="top"></td><td valign="top"><em>password</em> </td><td>password to use when logging in</td></tr>
</table>
</dl>
<b>BEWARE:</b> These parameters are not in the same order as those in the corresponding constructor for <a class="el" href="classmysqlpp_1_1Connection.html">Connection</a>. This is a feature, not a bug. :)
</div>
</div><p>
<a class="anchor" name="f19b05063295b93feae5de92caad693c"></a><!-- doxytag: member="mysqlpp::TCPConnection::TCPConnection" ref="f19b05063295b93feae5de92caad693c" args="(const TCPConnection &other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mysqlpp::TCPConnection::TCPConnection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classmysqlpp_1_1TCPConnection.html">TCPConnection</a> & </td>
<td class="paramname"> <em>other</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Establish a new connection using the same parameters as an existing connection.
<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>other</em> </td><td>pre-existing connection to clone </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d111bd8e49a43b3ab4972d67459efaa5"></a><!-- doxytag: member="mysqlpp::TCPConnection::connect" ref="d111bd8e49a43b3ab4972d67459efaa5" args="(const char *addr=0, const char *db=0, const char *user=0, const char *password=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mysqlpp::TCPConnection::connect </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>addr</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>db</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>user</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>password</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Connect to database after object is created.
<p>
It's better to use the connect-on-create constructor if you can. See its documentation for the meaning of these parameters.<p>
If you call this method on an object that is already connected to a database server, the previous connection is dropped and a new connection is established.
</div>
</div><p>
<a class="anchor" name="5726d3cf9dbd843686dcee1fe0899595"></a><!-- doxytag: member="mysqlpp::TCPConnection::parse_address" ref="5726d3cf9dbd843686dcee1fe0899595" args="(std::string &addr, unsigned int &port, std::string &error)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool mysqlpp::TCPConnection::parse_address </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int & </td>
<td class="paramname"> <em>port</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string & </td>
<td class="paramname"> <em>error</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Break the given TCP/IP address up into a separate address and port form.
<p>
Does some sanity checking on the address. Only intended to try and prevent library misuse, not ensure that the address can actually be used to contact a server.<p>
It understands the following forms:<p>
<ul>
<li>1.2.3.4</li></ul>
<p>
<ul>
<li>a.b.com:89</li></ul>
<p>
<ul>
<li>d.e.fr:mysvcname</li></ul>
<p>
It also understands IPv6 addresses, but to avoid confusion between the colons they use and the colon separating the address part from the service/port part, they must be in RFC 2732 form. Example: <code></code>[2010:836B:4179::836B:4179]:1234<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>addr</em> </td><td>the address and optional port/service combo to check on input, and the verified address on successful return </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>the port number (resolved from the service name if necessary) on successful return </td></tr>
<tr><td valign="top"></td><td valign="top"><em>error</em> </td><td>on false return, reason for failure is placed here</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>false if address fails to pass sanity checks </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="tcp__connection_8h-source.html">tcp_connection.h</a><li>tcp_connection.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Wed Feb 4 14:43:35 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>
|
