<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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"/>
<title>Soprano: Soprano::Client::LocalSocketClient Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="navpath">
<ul>
<li><a class="el" href="namespaceSoprano.html">Soprano</a> </li>
<li><a class="el" href="namespaceSoprano_1_1Client.html">Client</a> </li>
<li><a class="el" href="classSoprano_1_1Client_1_1LocalSocketClient.html">Soprano::Client::LocalSocketClient</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-slots">Public Slots</a> |
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Soprano::Client::LocalSocketClient Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Soprano::Client::LocalSocketClient" --><!-- doxytag: inherits="QObject,Soprano::Error::ErrorCache" -->
<p>Creates a connection to the Soprano server through a local socket interface.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="localsocketclient_8h_source.html">Soprano/Client/LocalSocketClient</a>></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for Soprano::Client::LocalSocketClient:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classSoprano_1_1Client_1_1LocalSocketClient__inherit__graph.png" border="0" usemap="#Soprano_1_1Client_1_1LocalSocketClient_inherit__map" alt="Inheritance graph"/></div>
<map name="Soprano_1_1Client_1_1LocalSocketClient_inherit__map" id="Soprano_1_1Client_1_1LocalSocketClient_inherit__map">
<area shape="rect" id="node2" href="qobject.html" title="QObject" alt="" coords="11,5,80,35"/><area shape="rect" id="node4" href="classSoprano_1_1Error_1_1ErrorCache.html" title="Core class of Soprano's exception system." alt="" coords="104,5,283,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classSoprano_1_1Client_1_1LocalSocketClient-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1LocalSocketClient.html#af141f479bee6070f314a8291e2fc069e">connect</a> (const <a class="elRef" href="qstring.html">QString</a> &<a class="elRef" href="qobject.html#name">name</a>=<a class="elRef" href="qstring.html">QString</a>())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1LocalSocketClient.html#a4cecc2ad5a89eb3bfedbf5fae79729a1">disconnect</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1LocalSocketClient.html#ab63bb8b972f228e4dbe76360f89eaef9">LocalSocketClient</a> (<a class="elRef" href="qobject.html">QObject</a> *<a class="elRef" href="qobject.html#parent">parent</a>=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1LocalSocketClient.html#a759e203d64f026dcdb3f94fa3b6fe5e9">~LocalSocketClient</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1LocalSocketClient.html#a2d5b6aa09dd474581e6141e2682e1549">isConnected</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classSoprano_1_1Model.html">Model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1LocalSocketClient.html#a36a743c4642d9f351089ce9aae32f8ba">createModel</a> (const <a class="elRef" href="qstring.html">QString</a> &<a class="elRef" href="qobject.html#name">name</a>, const <a class="elRef" href="qlist.html">QList</a>< <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> > &settings=<a class="elRef" href="qlist.html">QList</a>< <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> >())</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSoprano_1_1Client_1_1LocalSocketClient.html#a86e024d6c9fb9c252c098bdb148a8e04">removeModel</a> (const <a class="elRef" href="qstring.html">QString</a> &<a class="elRef" href="qobject.html#name">name</a>)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Creates a connection to the Soprano server through a local socket interface. </p>
<p>The Soprano server supports more than one way of communication. Beside D-Bus (see <a class="el" href="classSoprano_1_1Client_1_1DBusClient.html" title="Core class to handle a connection to a Soprano server through the DBus interface.">DBusClient</a>) it can be contacted via a local socket.</p>
<p>Models creates by this client are thread-safe and provide faster access to the server than D-Bus communication.</p>
<dl class="warning"><dt><b>Warning:</b></dt><dd>The <a class="el" href="classSoprano_1_1Client_1_1LocalSocketClient.html" title="Creates a connection to the Soprano server through a local socket interface.">LocalSocketClient</a> does not support signals. Thus, the models created by it will not emit signals such as <a class="el" href="classSoprano_1_1Model.html#a3e2595166caac3621fd4268e46049adf">Model::statementAdded</a>.</dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Sebastian Trueg <<a href="mailto:trueg@kde.org">trueg@kde.org</a>></dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>2.1 </dd></dl>
<p>Definition at line <a class="el" href="localsocketclient_8h_source.html#l00057">57</a> of file <a class="el" href="localsocketclient_8h_source.html">localsocketclient.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab63bb8b972f228e4dbe76360f89eaef9"></a><!-- doxytag: member="Soprano::Client::LocalSocketClient::LocalSocketClient" ref="ab63bb8b972f228e4dbe76360f89eaef9" args="(QObject *parent=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Soprano::Client::LocalSocketClient::LocalSocketClient </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qobject.html">QObject</a> * </td>
<td class="paramname"> <em>parent</em> = <code>0</code></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new <a class="el" href="namespaceSoprano_1_1Client.html">Client</a> instance. </p>
</div>
</div>
<a class="anchor" id="a759e203d64f026dcdb3f94fa3b6fe5e9"></a><!-- doxytag: member="Soprano::Client::LocalSocketClient::~LocalSocketClient" ref="a759e203d64f026dcdb3f94fa3b6fe5e9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Soprano::Client::LocalSocketClient::~LocalSocketClient </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2d5b6aa09dd474581e6141e2682e1549"></a><!-- doxytag: member="Soprano::Client::LocalSocketClient::isConnected" ref="a2d5b6aa09dd474581e6141e2682e1549" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Soprano::Client::LocalSocketClient::isConnected </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the client is connected to a server.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> if this client is connected to a server, <code>false</code> otherwise. </dd></dl>
</div>
</div>
<a class="anchor" id="a36a743c4642d9f351089ce9aae32f8ba"></a><!-- doxytag: member="Soprano::Client::LocalSocketClient::createModel" ref="a36a743c4642d9f351089ce9aae32f8ba" args="(const QString &name, const QList< BackendSetting > &settings=QList< BackendSetting >())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classSoprano_1_1Model.html">Model</a>* Soprano::Client::LocalSocketClient::createModel </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qlist.html">QList</a>< <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> > & </td>
<td class="paramname"> <em>settings</em> = <code><a class="elRef" href="qlist.html">QList</a>< <a class="el" href="classSoprano_1_1BackendSetting.html">BackendSetting</a> >()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new <a class="el" href="classSoprano_1_1Model.html" title="A Model is the central class in Soprano. It is a queryable collection of RDF quadruples, i.e statements.">Model</a> instance that wraps a server model. Client models are very light wrappers and creating them is very fast.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the model to access. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>The settings to send to the server for creating a new model. These settings may be ignored by the server if a model with that name has already been created.</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classSoprano_1_1Model.html" title="A Model is the central class in Soprano. It is a queryable collection of RDF quadruples, i.e statements.">Model</a> instance wrapping the requested server model or 0 on error (check <a class="el" href="classSoprano_1_1Error_1_1ErrorCache.html#a3251b8052cdf932d59a523ca215d21c9">lastError()</a> for details.) </dd></dl>
</div>
</div>
<a class="anchor" id="a86e024d6c9fb9c252c098bdb148a8e04"></a><!-- doxytag: member="Soprano::Client::LocalSocketClient::removeModel" ref="a86e024d6c9fb9c252c098bdb148a8e04" args="(const QString &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Client::LocalSocketClient::removeModel </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Deletes a model including all its data.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>The name of the model to remove.</td></tr>
</table>
</dd>
</dl>
<dl class="warning"><dt><b>Warning:</b></dt><dd>Calling this method will remove all data physically. It can not be reverted. Use with care. </dd></dl>
</div>
</div>
<a class="anchor" id="af141f479bee6070f314a8291e2fc069e"></a><!-- doxytag: member="Soprano::Client::LocalSocketClient::connect" ref="af141f479bee6070f314a8291e2fc069e" args="(const QString &name=QString())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Soprano::Client::LocalSocketClient::connect </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"> <em>name</em> = <code><a class="elRef" href="qstring.html">QString</a>()</code></td>
<td> ) </td>
<td><code> [slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tries to connect to the Soprano server.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd><code>true</code> on success, <code>false</code> if an error occured. Check <a class="el" href="classSoprano_1_1Error_1_1ErrorCache.html#a3251b8052cdf932d59a523ca215d21c9">lastError()</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="a4cecc2ad5a89eb3bfedbf5fae79729a1"></a><!-- doxytag: member="Soprano::Client::LocalSocketClient::disconnect" ref="a4cecc2ad5a89eb3bfedbf5fae79729a1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Soprano::Client::LocalSocketClient::disconnect </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Disconnect from the server. The created model instances are not deleted but remain useless; open iterators are closed. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/builddir/build/BUILD/soprano-2.5.2/client/<a class="el" href="localsocketclient_8h_source.html">localsocketclient.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Thu Oct 21 2010 for Soprano by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
13
>
x86_64
>
media
>
updates
>
by-pkgid
>
fc669c0115c2f74e1d26807f2cb98f7a
>
files
>
79
