diff options
Diffstat (limited to 'libcontextprovider/doc/html/class_context_provider_1_1_service.html')
| -rw-r--r-- | libcontextprovider/doc/html/class_context_provider_1_1_service.html | 349 |
1 files changed, 349 insertions, 0 deletions
diff --git a/libcontextprovider/doc/html/class_context_provider_1_1_service.html b/libcontextprovider/doc/html/class_context_provider_1_1_service.html new file mode 100644 index 00000000..64d64d70 --- /dev/null +++ b/libcontextprovider/doc/html/class_context_provider_1_1_service.html @@ -0,0 +1,349 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>libcontextprovider: ContextProvider::Service 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.5.8 --> +<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><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="tabs"> + <ul> + <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"><a class="el" href="namespace_context_provider.html">ContextProvider</a>::<a class="el" href="class_context_provider_1_1_service.html">Service</a> + </div> +</div> +<div class="contents"> +<h1>ContextProvider::Service Class Reference</h1><!-- doxytag: class="ContextProvider::Service" -->A <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> object is a proxy representing a service on D-Bus that implements the Context Framework interface. The lifespan of the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> class is not tied to the real service lifespan. This way a service can be accessed and controled from different parts of the code. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="service_8h-source.html">service.h</a>></code> +<p> + +<p> +<a href="class_context_provider_1_1_service-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Signals</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#018328acf52eadbcab3d0fefd6a1a268">startMe</a> ()</td></tr> + +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#2a7310e48f9592828aea6b3f5fda181e">Service</a> (QDBusConnection::BusType busType, const QString &busName, QObject *parent=0)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> proxy object for <em>busName</em> on the bus indicated by <em>busType</em>. <a href="#2a7310e48f9592828aea6b3f5fda181e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#365b50365fd98d8ee7a1b7dd10dd84d2">~Service</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys this <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> class. <a href="#365b50365fd98d8ee7a1b7dd10dd84d2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#6434d467cd84a6295bd24572671b5479">start</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Start the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> again after it has been stopped. <a href="#6434d467cd84a6295bd24572671b5479"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#25cc85c61a07afe679266fc287da0677">stop</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop the service. This will cause it to disappear from D-Bus. <a href="#25cc85c61a07afe679266fc287da0677"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#471dbe35bbd9583f9404b15158f367dd">restart</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">If the service is running, stop and start it. <a href="#471dbe35bbd9583f9404b15158f367dd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#385b58aef7878b6e33a3989d139f9a4a">setAsDefault</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> object as the default one to use when constructing <a class="el" href="class_context_provider_1_1_property.html" title="A Property object represents a context property, i.e., a key-value pair.">Property</a> objects. <a href="#385b58aef7878b6e33a3989d139f9a4a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#ee524632842792e9ad80b122eb8600a1">setValue</a> (const QString &key, const QVariant &val)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the value of <em>key</em> to <em>val</em>. <a href="#ee524632842792e9ad80b122eb8600a1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#d6bf1d2d8f8c580d4d77e9c4e72fd226">setConnection</a> (const QDBusConnection &connection)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set (override) the dbus <em>connection</em> to use by the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a>. <a href="#d6bf1d2d8f8c580d4d77e9c4e72fd226"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#386f5a9cf65610cb62143865e5637272">Property</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_service.html#c3553c08a0c7b57a4c15794caebf1936">::ServiceUnitTest</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> object is a proxy representing a service on D-Bus that implements the Context Framework interface. The lifespan of the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> class is not tied to the real service lifespan. This way a service can be accessed and controled from different parts of the code. +<p> +When you first create a <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> class with given session/name params the real dbus service instance is actually created and started. Future references to this session/name will give you a <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> instance that points to the very same service as the first <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> initialization that started it. In other words, we can say that the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> class represents a proxy interface to the real dbus service.<p> +When the last instance of <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> is destroyed, the real service is automatically terminated and destroyed (there is a simple ref counting mechanism involved to guarantee that).<p> +Consider the following examples:<p> +<div class="fragment"><pre class="fragment"> <a class="code" href="class_context_provider_1_1_service.html#2a7310e48f9592828aea6b3f5fda181e" title="Creates a Service proxy object for busName on the bus indicated by busType.">Service</a> *s1 = <span class="keyword">new</span> <a class="code" href="class_context_provider_1_1_service.html#2a7310e48f9592828aea6b3f5fda181e" title="Creates a Service proxy object for busName on the bus indicated by busType.">Service</a>(<span class="stringliteral">"QDBusConnection::SessionBus, "</span>com.example.simple<span class="stringliteral">");</span> +<span class="stringliteral"> Service *s2 = new Service("</span>QDBusConnection::SessionBus, <span class="stringliteral">"com.example.simple"</span>); + <span class="comment">// s1 and s2 represent same service</span> + + s1->start(); + <span class="comment">// Bots s1 and s2 are now started</span> + + s2->start(); + <span class="comment">// Bots s1 and s2 are now stopped</span> + + <span class="keyword">delete</span> s1; <span class="comment">// s2 is still valid, service is present</span> + <span class="keyword">delete</span> s2; <span class="comment">// the "com.example.simple" just disappeared from</span> +</pre></div><p> +Every <a class="el" href="class_context_provider_1_1_property.html" title="A Property object represents a context property, i.e., a key-value pair.">Property</a> object must be associated with a <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> object.<p> +A <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> can be running or stopped. When it is running, it is visible via D-Bus and clients can subscribe to its properties.<p> +It is undefined what happens when you add a <a class="el" href="class_context_provider_1_1_property.html" title="A Property object represents a context property, i.e., a key-value pair.">Property</a> object to a running service. Likewise, it is undefined what happens when you add a <a class="el" href="class_context_provider_1_1_property.html" title="A Property object represents a context property, i.e., a key-value pair.">Property</a> to a <a class="el" href="class_context_provider_1_1_group.html" title="Groups the firstSubscriberAppeared and lastSubscriberDisappeared from multiple Property...">Group</a> while the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> of that <a class="el" href="class_context_provider_1_1_property.html" title="A Property object represents a context property, i.e., a key-value pair.">Property</a> object is running.<p> +Thus, it is best to create a <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> object, add all <a class="el" href="class_context_provider_1_1_property.html" title="A Property object represents a context property, i.e., a key-value pair.">Property</a> objects to it immediately, create the <a class="el" href="class_context_provider_1_1_group.html" title="Groups the firstSubscriberAppeared and lastSubscriberDisappeared from multiple Property...">Group</a> objects for them, and then enter the main loop, which will cause the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> to start. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="2a7310e48f9592828aea6b3f5fda181e"></a><!-- doxytag: member="ContextProvider::Service::Service" ref="2a7310e48f9592828aea6b3f5fda181e" args="(QDBusConnection::BusType busType, const QString &busName, QObject *parent=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextProvider::Service::Service </td> + <td>(</td> + <td class="paramtype">QDBusConnection::BusType </td> + <td class="paramname"> <em>busType</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>busName</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [explicit]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Creates a <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> proxy object for <em>busName</em> on the bus indicated by <em>busType</em>. +<p> +If the service is accessed for the first time it'll be created and set up. If the service with the given parameters already exists the created object represents a controller to a previously-created service. A new <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> is initially stopped and will automatically start itself when the main loop is entered. +</div> +</div><p> +<a class="anchor" name="365b50365fd98d8ee7a1b7dd10dd84d2"></a><!-- doxytag: member="ContextProvider::Service::~Service" ref="365b50365fd98d8ee7a1b7dd10dd84d2" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextProvider::Service::~Service </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Destroys this <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> class. +<p> +The actual service on dbus is destroyed and stopped if this object is a last instance pointing at the actual service with the given name and session params. +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="471dbe35bbd9583f9404b15158f367dd"></a><!-- doxytag: member="ContextProvider::Service::restart" ref="471dbe35bbd9583f9404b15158f367dd" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Service::restart </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +If the service is running, stop and start it. +<p> + +</div> +</div><p> +<a class="anchor" name="385b58aef7878b6e33a3989d139f9a4a"></a><!-- doxytag: member="ContextProvider::Service::setAsDefault" ref="385b58aef7878b6e33a3989d139f9a4a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Service::setAsDefault </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> object as the default one to use when constructing <a class="el" href="class_context_provider_1_1_property.html" title="A Property object represents a context property, i.e., a key-value pair.">Property</a> objects. +<p> + +</div> +</div><p> +<a class="anchor" name="d6bf1d2d8f8c580d4d77e9c4e72fd226"></a><!-- doxytag: member="ContextProvider::Service::setConnection" ref="d6bf1d2d8f8c580d4d77e9c4e72fd226" args="(const QDBusConnection &connection)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Service::setConnection </td> + <td>(</td> + <td class="paramtype">const QDBusConnection & </td> + <td class="paramname"> <em>connection</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set (override) the dbus <em>connection</em> to use by the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a>. +<p> +When the dbus connection is specified using this function the service is NOT automatically registered on the bus. It's ok to call this function many times as long as the connection name is the same all the time. It's NOT okay to call this function more than one time with connections with different names. +</div> +</div><p> +<a class="anchor" name="ee524632842792e9ad80b122eb8600a1"></a><!-- doxytag: member="ContextProvider::Service::setValue" ref="ee524632842792e9ad80b122eb8600a1" args="(const QString &key, const QVariant &val)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Service::setValue </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QVariant & </td> + <td class="paramname"> <em>val</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Set the value of <em>key</em> to <em>val</em>. +<p> +A property named <em>key</em> must have been registered already, by creating a <a class="el" href="class_context_provider_1_1_property.html" title="A Property object represents a context property, i.e., a key-value pair.">Property</a> object for it. +</div> +</div><p> +<a class="anchor" name="6434d467cd84a6295bd24572671b5479"></a><!-- doxytag: member="ContextProvider::Service::start" ref="6434d467cd84a6295bd24572671b5479" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool ContextProvider::Service::start </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Start the <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the Context...">Service</a> again after it has been stopped. +<p> +All clients will resubscribe to its properties. Returns true on success, false otherwise. +</div> +</div><p> +<a class="anchor" name="018328acf52eadbcab3d0fefd6a1a268"></a><!-- doxytag: member="ContextProvider::Service::startMe" ref="018328acf52eadbcab3d0fefd6a1a268" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Service::startMe </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="25cc85c61a07afe679266fc287da0677"></a><!-- doxytag: member="ContextProvider::Service::stop" ref="25cc85c61a07afe679266fc287da0677" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Service::stop </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Stop the service. This will cause it to disappear from D-Bus. +<p> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="c3553c08a0c7b57a4c15794caebf1936"></a><!-- doxytag: member="ContextProvider::Service::::ServiceUnitTest" ref="c3553c08a0c7b57a4c15794caebf1936" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class ::ServiceUnitTest<code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="386f5a9cf65610cb62143865e5637272"></a><!-- doxytag: member="ContextProvider::Service::Property" ref="386f5a9cf65610cb62143865e5637272" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="class_context_provider_1_1_property.html">Property</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="service_8h-source.html">service.h</a><li><a class="el" href="service_8cpp.html">service.cpp</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 21 16:36:23 2009 for libcontextprovider by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +</body> +</html> |