<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdbuscontext.cpp -->
<title>Qt 4.8: QDBusContext Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtdbus.html">QtDBus</a></li>
<li>QDBusContext</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QDBusContext Class Reference</h1>
<!-- $$$QDBusContext-brief -->
<p>The QDBusContext class allows slots to determine the D-Bus context of the calls. <a href="#details">More...</a></p>
<!-- @@@QDBusContext -->
<pre class="cpp"> <span class="preprocessor">#include <QDBusContext></span></pre><p>This class was introduced in Qt 4.3.</p>
<ul>
<li><a href="qdbuscontext-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdbuscontext.html#QDBusContext">QDBusContext</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qdbuscontext.html#dtor.QDBusContext">~QDBusContext</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdbuscontext.html#calledFromDBus">calledFromDBus</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QDBusConnection </td><td class="memItemRight bottomAlign"><b><a href="qdbuscontext.html#connection">connection</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qdbuscontext.html#isDelayedReply">isDelayedReply</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QDBusMessage & </td><td class="memItemRight bottomAlign"><b><a href="qdbuscontext.html#message">message</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdbuscontext.html#sendErrorReply">sendErrorReply</a></b> ( const QString & <i>name</i>, const QString & <i>msg</i> = QString() ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdbuscontext.html#sendErrorReply-2">sendErrorReply</a></b> ( QDBusError::ErrorType <i>type</i>, const QString & <i>msg</i> = QString() ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qdbuscontext.html#setDelayedReply">setDelayedReply</a></b> ( bool <i>enable</i> ) const</td></tr>
</table>
<a name="details"></a>
<!-- $$$QDBusContext-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QDBusContext class allows slots to determine the D-Bus context of the calls.</p>
<p>When a slot is called in an object due to a signal delivery or due to a remote method call, it is sometimes necessary to know the context in which that happened. In particular, if the slot determines that it wants to send the reply at a later opportunity or if it wants to reply with an error, the context is needed.</p>
<p>The QDBusContext class is an alternative to accessing the context that doesn't involve modifying the code generated by the <a href="qdbusxml2cpp.html">QtDBus XML Compiler (qdbusxml2cpp)</a>.</p>
<p>QDBusContext is used by subclassing it from the objects being exported using <a href="qdbusconnection.html#registerObject">QDBusConnection::registerObject</a>(). The following example illustrates the usage:</p>
<pre class="cpp"> <span class="keyword">class</span> MyObject: <span class="keyword">public</span> <span class="type"><a href="qobject.html">QObject</a></span><span class="operator">,</span>
<span class="keyword">protected</span> <span class="type">QDBusContext</span>
{
Q_OBJECT
<span class="type"><a href="qdbusconnection.html">QDBusConnection</a></span> conn;
<span class="type"><a href="qdbusmessage.html">QDBusMessage</a></span> msg;
<span class="operator">.</span><span class="operator">.</span><span class="operator">.</span>
<span class="keyword">protected</span> <span class="keyword">slots</span>:
<span class="type">void</span> process();
<span class="keyword">public</span> <span class="keyword">slots</span>:
<span class="type">void</span> methodWithError();
<span class="type"><a href="qstring.html">QString</a></span> methodWithDelayedReply();
};
<span class="type">void</span> MyObject<span class="operator">::</span>methodWithError()
{
sendErrorReply(<span class="type"><a href="qdbuserror.html">QDBusError</a></span><span class="operator">::</span>NotSupported<span class="operator">,</span>
<span class="string">"The method call 'methodWithError()' is not supported"</span>);
}
<span class="type"><a href="qstring.html">QString</a></span> MyObject<span class="operator">::</span>methodWithDelayedReply()
{
conn <span class="operator">=</span> connection();
msg <span class="operator">=</span> message();
setDelayedReply(<span class="keyword">true</span>);
<span class="type"><a href="qmetaobject.html">QMetaObject</a></span><span class="operator">::</span>invokeMethod(<span class="keyword">this</span><span class="operator">,</span> <span class="string">"process"</span><span class="operator">,</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>QueuedConnection);
<span class="keyword">return</span> <span class="type"><a href="qstring.html">QString</a></span>();
}</pre>
<p>The example illustrates the two typical uses, that of sending error replies and that of delayed replies.</p>
<p>Note: do not subclass QDBusContext and <a href="qdbusabstractadaptor.html">QDBusAbstractAdaptor</a> at the same time. QDBusContext should appear in the real object, not the adaptor. If it's necessary from the adaptor code to determine the context, use a public inheritance and access the functions via <a href="qobject.html#parent">QObject::parent</a>().</p>
</div>
<!-- @@@QDBusContext -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QDBusContext[overload1]$$$QDBusContext -->
<h3 class="fn"><a name="QDBusContext"></a>QDBusContext::<span class="name">QDBusContext</span> ()</h3>
<p>Constructs an empty <a href="qdbuscontext.html">QDBusContext</a>.</p>
<!-- @@@QDBusContext -->
<!-- $$$~QDBusContext[overload1]$$$~QDBusContext -->
<h3 class="fn"><a name="dtor.QDBusContext"></a>QDBusContext::<span class="name">~QDBusContext</span> ()</h3>
<p>An empty destructor.</p>
<!-- @@@~QDBusContext -->
<!-- $$$calledFromDBus[overload1]$$$calledFromDBus -->
<h3 class="fn"><a name="calledFromDBus"></a><span class="type">bool</span> QDBusContext::<span class="name">calledFromDBus</span> () const</h3>
<p>Returns true if we are processing a D-Bus call. If this function returns true, the rest of the functions in this class are available.</p>
<p>Accessing those functions when this function returns false is undefined and may lead to crashes.</p>
<!-- @@@calledFromDBus -->
<!-- $$$connection[overload1]$$$connection -->
<h3 class="fn"><a name="connection"></a><span class="type"><a href="qdbusconnection.html">QDBusConnection</a></span> QDBusContext::<span class="name">connection</span> () const</h3>
<p>Returns the connection from which this call was received.</p>
<!-- @@@connection -->
<!-- $$$isDelayedReply[overload1]$$$isDelayedReply -->
<h3 class="fn"><a name="isDelayedReply"></a><span class="type">bool</span> QDBusContext::<span class="name">isDelayedReply</span> () const</h3>
<p>Returns true if this call will have a delayed reply.</p>
<p><b>See also </b><a href="qdbuscontext.html#setDelayedReply">setDelayedReply</a>().</p>
<!-- @@@isDelayedReply -->
<!-- $$$message[overload1]$$$message -->
<h3 class="fn"><a name="message"></a>const <span class="type"><a href="qdbusmessage.html">QDBusMessage</a></span> & QDBusContext::<span class="name">message</span> () const</h3>
<p>Returns the message that generated this call.</p>
<!-- @@@message -->
<!-- $$$sendErrorReply[overload1]$$$sendErrorReplyconstQString&constQString& -->
<h3 class="fn"><a name="sendErrorReply"></a><span class="type">void</span> QDBusContext::<span class="name">sendErrorReply</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>name</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>msg</i> = QString() ) const</h3>
<p>Sends an error <i>name</i> as a reply to the caller. The optional <i>msg</i> parameter is a human-readable text explaining the failure.</p>
<p>If an error is sent, the return value and any output parameters from the called slot will be ignored by <a href="qtdbus.html">QtDBus</a>.</p>
<!-- @@@sendErrorReply -->
<!-- $$$sendErrorReply$$$sendErrorReplyQDBusError::ErrorTypeconstQString& -->
<h3 class="fn"><a name="sendErrorReply-2"></a><span class="type">void</span> QDBusContext::<span class="name">sendErrorReply</span> ( <span class="type"><a href="qdbuserror.html#ErrorType-enum">QDBusError::ErrorType</a></span> <i>type</i>, const <span class="type"><a href="qstring.html">QString</a></span> & <i>msg</i> = QString() ) const</h3>
<p>This is an overloaded function.</p>
<p>Sends an error <i>type</i> as a reply to the caller. The optional <i>msg</i> parameter is a human-readable text explaining the failure.</p>
<p>If an error is sent, the return value and any output parameters from the called slot will be ignored by <a href="qtdbus.html">QtDBus</a>.</p>
<!-- @@@sendErrorReply -->
<!-- $$$setDelayedReply[overload1]$$$setDelayedReplybool -->
<h3 class="fn"><a name="setDelayedReply"></a><span class="type">void</span> QDBusContext::<span class="name">setDelayedReply</span> ( <span class="type">bool</span> <i>enable</i> ) const</h3>
<p>Sets whether this call will have a delayed reply or not.</p>
<p>If <i>enable</i> is false, <a href="qtdbus.html">QtDBus</a> will automatically generate a reply back to the caller, if needed, as soon as the called slot returns.</p>
<p>If <i>enable</i> is true, <a href="qtdbus.html">QtDBus</a> will not generate automatic replies. It will also ignore the return value from the slot and any output parameters. Instead, the called object is responsible for storing the incoming message and send a reply or error at a later time.</p>
<p>Failing to send a reply will result in an automatic timeout error being generated by D-Bus.</p>
<p><b>See also </b><a href="qdbuscontext.html#isDelayedReply">isDelayedReply</a>().</p>
<!-- @@@setDelayedReply -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
