<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Xapian: API Documentation: xapian-core: Xapian::Remote Namespace Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
</ul>
</div>
<div class="nav">
<a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="namespaceXapian_1_1Remote.html">Remote</a></div>
<h1>Xapian::Remote Namespace Reference</h1><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="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap 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#f31538080e8bee828e9fdd340c717926">open</a> (const std::string &host, unsigned int port, <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">timeout</a>=10000, <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> connect_timeout=10000)</td></tr>
<tr><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="#f31538080e8bee828e9fdd340c717926"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#2cf65f946180533b3e143b3f0cc15f3a">open_writable</a> (const std::string &host, unsigned int port, <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">timeout</a>=0, <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> connect_timeout=10000)</td></tr>
<tr><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="#2cf65f946180533b3e143b3f0cc15f3a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#bbbbbfd0547457f2bec5981cd5be12f9">open</a> (const std::string &program, const std::string &args, <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">timeout</a>=10000)</td></tr>
<tr><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="#bbbbbfd0547457f2bec5981cd5be12f9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap 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#c06af2c8ab45890cba47afa99015b7a4">open_writable</a> (const std::string &program, const std::string &args, <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> <a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">timeout</a>=0)</td></tr>
<tr><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="#c06af2c8ab45890cba47afa99015b7a4"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<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. <hr><h2>Function Documentation</h2>
<a class="anchor" name="bbbbbfd0547457f2bec5981cd5be12f9"></a><!-- doxytag: member="Xapian::Remote::open" ref="bbbbbfd0547457f2bec5981cd5be12f9" args="(const std::string &program, const std::string &args, Xapian::timeout timeout=10000)" -->
<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"><a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> </td>
<td class="paramname"> <em>timeout</em> = <code>10000</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>
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>
Access to the remote database is done by running an external program and communicating with it on stdin/stdout.<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>program</em> </td><td>the external program to run. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>space-separated list of arguments to pass to program. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </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>
</dl>
</div>
</div><p>
<a class="anchor" name="f31538080e8bee828e9fdd340c717926"></a><!-- doxytag: member="Xapian::Remote::open" ref="f31538080e8bee828e9fdd340c717926" args="(const std::string &host, unsigned int port, Xapian::timeout timeout=10000, Xapian::timeout connect_timeout=10000)" -->
<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"><a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> </td>
<td class="paramname"> <em>timeout</em> = <code>10000</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> </td>
<td class="paramname"> <em>connect_timeout</em> = <code>10000</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>
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>
Access to the remote database is via a TCP connection to the specified host and port.<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>host</em> </td><td>hostname to connect to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>port number to connect to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </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 valign="top"></td><td valign="top"><em>connect_timeout</em> </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>
</dl>
</div>
</div><p>
<a class="anchor" name="c06af2c8ab45890cba47afa99015b7a4"></a><!-- doxytag: member="Xapian::Remote::open_writable" ref="c06af2c8ab45890cba47afa99015b7a4" args="(const std::string &program, const std::string &args, Xapian::timeout timeout=0)" -->
<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"><a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> </td>
<td class="paramname"> <em>timeout</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>
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>
Access to the remote database is done by running an external program and communicating with it on stdin/stdout.<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>program</em> </td><td>the external program to run. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>space-separated list of arguments to pass to program. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </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>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2cf65f946180533b3e143b3f0cc15f3a"></a><!-- doxytag: member="Xapian::Remote::open_writable" ref="2cf65f946180533b3e143b3f0cc15f3a" args="(const std::string &host, unsigned int port, Xapian::timeout timeout=0, Xapian::timeout connect_timeout=10000)" -->
<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"><a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> </td>
<td class="paramname"> <em>timeout</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceXapian.html#ce9fad55db7f895158280afbe98d8a9a">Xapian::timeout</a> </td>
<td class="paramname"> <em>connect_timeout</em> = <code>10000</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>
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>
Access to the remote database is via a TCP connection to the specified host and port.<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>host</em> </td><td>hostname to connect to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>port number to connect to. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </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 valign="top"></td><td valign="top"><em>connect_timeout</em> </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>
</dl>
</div>
</div><p>
<hr>
<address><small>
Documentation for Xapian (version 1.0.21).<br>
Generated on 18 Jun 2010 by
<a href="http://www.doxygen.org/">Doxygen 1.5.2</a>.
</small></address>
</body>
</html>
