<!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.9 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><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="namespaces.html"><span>Namespace List</span></a></li>
<li><a href="namespacemembers.html"><span>Namespace Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="namespaceXapian_1_1Remote.html">Remote</a>
</div>
</div>
<div class="contents">
<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#3339d191d3dedb8cffcba2b23893ab26">open</a> (const std::string &host, unsigned int port, <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">Xapian::timeout</a> <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">timeout</a>=10000, <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">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="#3339d191d3dedb8cffcba2b23893ab26"></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#8d3a033b250f0340751436feaeab50c6">open_writable</a> (const std::string &host, unsigned int port, <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">Xapian::timeout</a> <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">timeout</a>=0, <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">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="#8d3a033b250f0340751436feaeab50c6"></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#a2c576f7d77c3c2f6b050622207ec708">open</a> (const std::string &program, const std::string &args, <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">Xapian::timeout</a> <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">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="#a2c576f7d77c3c2f6b050622207ec708"></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#e754da0aef45549d2500c702ed7526a4">open_writable</a> (const std::string &program, const std::string &args, <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">Xapian::timeout</a> <a class="el" href="namespaceXapian.html#da10bc23c3467246f078179fce2d762d">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="#e754da0aef45549d2500c702ed7526a4"></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.
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a2c576f7d77c3c2f6b050622207ec708"></a><!-- doxytag: member="Xapian::Remote::open" ref="a2c576f7d77c3c2f6b050622207ec708" 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#da10bc23c3467246f078179fce2d762d">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></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="3339d191d3dedb8cffcba2b23893ab26"></a><!-- doxytag: member="Xapian::Remote::open" ref="3339d191d3dedb8cffcba2b23893ab26" 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#da10bc23c3467246f078179fce2d762d">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#da10bc23c3467246f078179fce2d762d">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></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="e754da0aef45549d2500c702ed7526a4"></a><!-- doxytag: member="Xapian::Remote::open_writable" ref="e754da0aef45549d2500c702ed7526a4" 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#da10bc23c3467246f078179fce2d762d">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></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="8d3a033b250f0340751436feaeab50c6"></a><!-- doxytag: member="Xapian::Remote::open_writable" ref="8d3a033b250f0340751436feaeab50c6" 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#da10bc23c3467246f078179fce2d762d">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#da10bc23c3467246f078179fce2d762d">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></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>
</div>
<hr>
<address><small>
Documentation for Xapian (version 1.2.12).<br>
Generated on 27 Jun 2012 by
<a href="http://www.doxygen.org/">Doxygen 1.5.9</a>.
</small></address>
</body>
</html>
