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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<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.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::Remote Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.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">xapian-core
 <span id="projectnumber">1.4.22</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="namespaceXapian_1_1Remote.html">Remote</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">Xapian::Remote Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions for the remote backend.
<a href="namespaceXapian_1_1Remote.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aca6d4535825bbe637bc64b06ba6d0911"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Database.html">Database</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html#aca6d4535825bbe637bc64b06ba6d0911">open</a> (const std::string &host, unsigned int port, useconds_t <a class="el" href="namespaceXapian.html#ada10bc23c3467246f078179fce2d762d">timeout</a>=10000, useconds_t connect_timeout=10000)</td></tr>
<tr class="memdesc:aca6d4535825bbe637bc64b06ba6d0911"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object for read-only access to a remote database accessed via a TCP connection. <a href="namespaceXapian_1_1Remote.html#aca6d4535825bbe637bc64b06ba6d0911">More...</a><br /></td></tr>
<tr class="separator:aca6d4535825bbe637bc64b06ba6d0911"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84deed0508be12e092e63c0e5beb90d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html#a84deed0508be12e092e63c0e5beb90d3">open_writable</a> (const std::string &host, unsigned int port, useconds_t <a class="el" href="namespaceXapian.html#ada10bc23c3467246f078179fce2d762d">timeout</a>=0, useconds_t connect_timeout=10000, int flags=0)</td></tr>
<tr class="memdesc:a84deed0508be12e092e63c0e5beb90d3"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database.">WritableDatabase</a> object for update access to a remote database accessed via a TCP connection. <a href="namespaceXapian_1_1Remote.html#a84deed0508be12e092e63c0e5beb90d3">More...</a><br /></td></tr>
<tr class="separator:a84deed0508be12e092e63c0e5beb90d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11e2bf6e836693906f7137d6981f1d9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Database.html">Database</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html#a11e2bf6e836693906f7137d6981f1d9d">open</a> (const std::string &program, const std::string &args, useconds_t <a class="el" href="namespaceXapian.html#ada10bc23c3467246f078179fce2d762d">timeout</a>=10000)</td></tr>
<tr class="memdesc:a11e2bf6e836693906f7137d6981f1d9d"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object for read-only access to a remote database accessed via a program. <a href="namespaceXapian_1_1Remote.html#a11e2bf6e836693906f7137d6981f1d9d">More...</a><br /></td></tr>
<tr class="separator:a11e2bf6e836693906f7137d6981f1d9d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc7fd4a5c6b738dc83097347f0d760e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html#adc7fd4a5c6b738dc83097347f0d760e9">open_writable</a> (const std::string &program, const std::string &args, useconds_t <a class="el" href="namespaceXapian.html#ada10bc23c3467246f078179fce2d762d">timeout</a>=0, int flags=0)</td></tr>
<tr class="memdesc:adc7fd4a5c6b738dc83097347f0d760e9"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database.">WritableDatabase</a> object for update access to a remote database accessed via a program. <a href="namespaceXapian_1_1Remote.html#adc7fd4a5c6b738dc83097347f0d760e9">More...</a><br /></td></tr>
<tr class="separator:adc7fd4a5c6b738dc83097347f0d760e9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p ><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions for the remote backend. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="aca6d4535825bbe637bc64b06ba6d0911" name="aca6d4535825bbe637bc64b06ba6d0911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca6d4535825bbe637bc64b06ba6d0911">◆ </a></span>open() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1Database.html">Database</a> Xapian::Remote::open </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>host</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">useconds_t </td>
<td class="paramname"><em>timeout</em> = <code>10000</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">useconds_t </td>
<td class="paramname"><em>connect_timeout</em> = <code>10000</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object for read-only access to a remote database accessed via a TCP connection. </p>
<p >Access to the remote database is via a TCP connection to the specified host and port.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">host</td><td>hostname to connect to. </td></tr>
<tr><td class="paramname">port</td><td>port number to connect to. </td></tr>
<tr><td class="paramname">timeout</td><td>timeout in milliseconds. If this timeout is exceeded for any individual operation on the remote database then <a class="el" href="classXapian_1_1NetworkTimeoutError.html" title="Indicates a timeout expired while communicating with a remote database.">Xapian::NetworkTimeoutError</a> is thrown. A timeout of 0 means don't timeout. (Default is 10000ms, which is 10 seconds). </td></tr>
<tr><td class="paramname">connect_timeout</td><td>timeout to use when connecting to the server. If this timeout is exceeded then <a class="el" href="classXapian_1_1NetworkTimeoutError.html" title="Indicates a timeout expired while communicating with a remote database.">Xapian::NetworkTimeoutError</a> is thrown. A timeout of 0 means don't timeout. (Default is 10000ms, which is 10 seconds). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a11e2bf6e836693906f7137d6981f1d9d" name="a11e2bf6e836693906f7137d6981f1d9d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11e2bf6e836693906f7137d6981f1d9d">◆ </a></span>open() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1Database.html">Database</a> Xapian::Remote::open </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>program</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">useconds_t </td>
<td class="paramname"><em>timeout</em> = <code>10000</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object for read-only access to a remote database accessed via a program. </p>
<p >Access to the remote database is done by running an external program and communicating with it on stdin/stdout.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">program</td><td>the external program to run. </td></tr>
<tr><td class="paramname">args</td><td>space-separated list of arguments to pass to program. </td></tr>
<tr><td class="paramname">timeout</td><td>timeout in milliseconds. If this timeout is exceeded for any individual operation on the remote database then <a class="el" href="classXapian_1_1NetworkTimeoutError.html" title="Indicates a timeout expired while communicating with a remote database.">Xapian::NetworkTimeoutError</a> is thrown. A timeout of 0 means don't timeout. (Default is 10000ms, which is 10 seconds). </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a84deed0508be12e092e63c0e5beb90d3" name="a84deed0508be12e092e63c0e5beb90d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84deed0508be12e092e63c0e5beb90d3">◆ </a></span>open_writable() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> Xapian::Remote::open_writable </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>host</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">useconds_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">useconds_t </td>
<td class="paramname"><em>connect_timeout</em> = <code>10000</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database.">WritableDatabase</a> object for update access to a remote database accessed via a TCP connection. </p>
<p >Access to the remote database is via a TCP connection to the specified host and port.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">host</td><td>hostname to connect to. </td></tr>
<tr><td class="paramname">port</td><td>port number to connect to. </td></tr>
<tr><td class="paramname">timeout</td><td>timeout in milliseconds. If this timeout is exceeded for any individual operation on the remote database then <a class="el" href="classXapian_1_1NetworkTimeoutError.html" title="Indicates a timeout expired while communicating with a remote database.">Xapian::NetworkTimeoutError</a> is thrown. (Default is 0, which means don't timeout). </td></tr>
<tr><td class="paramname">connect_timeout</td><td>timeout to use when connecting to the server. If this timeout is exceeded then <a class="el" href="classXapian_1_1NetworkTimeoutError.html" title="Indicates a timeout expired while communicating with a remote database.">Xapian::NetworkTimeoutError</a> is thrown. A timeout of 0 means don't timeout. (Default is 10000ms, which is 10 seconds). </td></tr>
<tr><td class="paramname">flags</td><td><a class="el" href="namespaceXapian.html#a296fe000d6d9525bb8e80f72838026a6" title="If the database is already locked, retry the lock.">Xapian::DB_RETRY_LOCK</a> or 0. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adc7fd4a5c6b738dc83097347f0d760e9" name="adc7fd4a5c6b738dc83097347f0d760e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc7fd4a5c6b738dc83097347f0d760e9">◆ </a></span>open_writable() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> Xapian::Remote::open_writable </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>program</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>args</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">useconds_t </td>
<td class="paramname"><em>timeout</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>flags</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database.">WritableDatabase</a> object for update access to a remote database accessed via a program. </p>
<p >Access to the remote database is done by running an external program and communicating with it on stdin/stdout.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">program</td><td>the external program to run. </td></tr>
<tr><td class="paramname">args</td><td>space-separated list of arguments to pass to program. </td></tr>
<tr><td class="paramname">timeout</td><td>timeout in milliseconds. If this timeout is exceeded for any individual operation on the remote database then <a class="el" href="classXapian_1_1NetworkTimeoutError.html" title="Indicates a timeout expired while communicating with a remote database.">Xapian::NetworkTimeoutError</a> is thrown. (Default is 0, which means don't timeout). </td></tr>
<tr><td class="paramname">flags</td><td><a class="el" href="namespaceXapian.html#a296fe000d6d9525bb8e80f72838026a6" title="If the database is already locked, retry the lock.">Xapian::DB_RETRY_LOCK</a> or 0. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.4</a>
</small></address>
</body>
</html>
|
