Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-release > by-pkgid > c61c536f80c3d067f7ca643389c560f9 > files > 26

qtremoteobjects5-doc-5.12.2-2.mga7.noarch.rpm

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qremoteobjectnode.cpp -->
  <title>QRemoteObjectHost Class | Qt Remote Objects 5.12.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td >Qt 5.12</td><td ><a href="qtremoteobjects-index.html">Qt Remote Objects</a></td><td ><a href="qtremoteobjects-module.html">C++ Classes</a></td><td >QRemoteObjectHost</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtremoteobjects-index.html">Qt 5.12.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<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="#reimplemented-public-functions">Reimplemented Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">QRemoteObjectHost Class</h1>
<!-- $$$QRemoteObjectHost-brief -->
<p>A (Host) Node on a Qt Remote Objects network. <a href="#details">More...</a></p>
<!-- @@@QRemoteObjectHost -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign">   <span class="preprocessor">#include &lt;QRemoteObjectHost&gt;</span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += remoteobjects</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qremoteobjecthostbase.html">QRemoteObjectHostBase</a></td></tr></table></div><ul>
<li><a href="qremoteobjecthost-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qremoteobjecthost.html#QRemoteObjectHost">QRemoteObjectHost</a></b>(QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qremoteobjecthost.html#QRemoteObjectHost-1">QRemoteObjectHost</a></b>(const QUrl &amp;<i>address</i>, const QUrl &amp;<i>registryAddress</i> = QUrl(), QRemoteObjectHostBase::AllowedSchemas <i>allowedSchemas</i> = BuiltInSchemasOnly, QObject *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qremoteobjecthost.html#QRemoteObjectHost-2">QRemoteObjectHost</a></b>(const QUrl &amp;<i>address</i>, QObject *<i>parent</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qremoteobjecthost.html#dtor.QRemoteObjectHost">~QRemoteObjectHost</a></b>() override</td></tr>
</table></div>
<a name="reimplemented-public-functions"></a>
<h2 id="reimplemented-public-functions">Reimplemented Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual QUrl </td><td class="memItemRight bottomAlign"><b><a href="qremoteobjecthost.html#hostUrl">hostUrl</a></b>() const override</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qremoteobjecthost.html#setHostUrl">setHostUrl</a></b>(const QUrl &amp;<i>hostAddress</i>, QRemoteObjectHostBase::AllowedSchemas <i>allowedSchemas</i> = BuiltInSchemasOnly) override</td></tr>
</table></div>
<ul>
<li class="fn">8 public functions inherited from <a href="qremoteobjecthostbase.html#public-functions">QRemoteObjectHostBase</a></li>
<li class="fn">18 public functions inherited from <a href="qremoteobjectnode.html#public-functions">QRemoteObjectNode</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qremoteobjecthost.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">3 properties inherited from <a href="qremoteobjectnode.html#properties">QRemoteObjectNode</a></li>
<li class="fn">4 signals inherited from <a href="qremoteobjectnode.html#signals">QRemoteObjectNode</a></li>
<li class="fn">1 protected function inherited from <a href="qremoteobjectnode.html#protected-functions">QRemoteObjectNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QRemoteObjectHost-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>A (Host) Node on a Qt Remote Objects network.</p>
<p>The <a href="qremoteobjecthost.html">QRemoteObjectHost</a> class provides an entry point to a <a href="qtremoteobjects-qmlmodule.html">QtRemoteObjects</a> network. A network can be as simple as two nodes, or an arbitrarily complex set of processes and devices.</p>
<p>QRemoteObjectHosts have the same capabilities as QRemoteObjectNodes, but they can also be connected to and can share source objects on the network.</p>
<p>Nodes may connect to each other directly using <a href="qremoteobjectnode.html#connectToNode">connectToNode</a>, or they can use the <a href="qremoteobjectregistry.html">QRemoteObjectRegistry</a> to simplify connections.</p>
<p>The <a href="qremoteobjectregistry.html">QRemoteObjectRegistry</a> is a special replica available to every node that connects to the uegistry Url. It knows how to connect to every QRemoteObjectSource object on the network.</p>
</div>
<p><b>See also </b><a href="qremoteobjectnode.html">QRemoteObjectNode</a> and <a href="qremoteobjectregistryhost.html">QRemoteObjectRegistryHost</a>.</p>
<!-- @@@QRemoteObjectHost -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QRemoteObjectHost[overload1]$$$QRemoteObjectHostQObject* -->
<h3 class="fn" id="QRemoteObjectHost"><a name="QRemoteObjectHost"></a>QRemoteObjectHost::<span class="name">QRemoteObjectHost</span>(<span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new <a href="qremoteobjecthost.html">QRemoteObjectHost</a> Node (i.e&#x2e;, a Node that supports exposing <a href="qtremoteobjects-source.html#source">Source</a> objects on the QtRO network) with the given <i>parent</i>. This constructor is meant specific to support QML in the future as it will not be available to connect to until <a href="qremoteobjecthost.html#setHostUrl">setHostUrl</a>() is called.</p>
<p><b>See also </b><a href="qremoteobjecthost.html#setHostUrl">setHostUrl</a>, (), and <a href="qremoteobjectnode.html#registryUrl-prop">setRegistryUrl</a>().</p>
<!-- @@@QRemoteObjectHost -->
<!-- $$$QRemoteObjectHost$$$QRemoteObjectHostconstQUrl&constQUrl&QRemoteObjectHostBase::AllowedSchemasQObject* -->
<h3 class="fn" id="QRemoteObjectHost-1"><a name="QRemoteObjectHost-1"></a>QRemoteObjectHost::<span class="name">QRemoteObjectHost</span>(const <span class="type">QUrl</span> &amp;<i>address</i>, const <span class="type">QUrl</span> &amp;<i>registryAddress</i> = QUrl(), <span class="type"><a href="qremoteobjecthostbase.html#AllowedSchemas-enum">QRemoteObjectHostBase::AllowedSchemas</a></span> <i>allowedSchemas</i> = BuiltInSchemasOnly, <span class="type">QObject</span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new <a href="qremoteobjecthost.html">QRemoteObjectHost</a> Node (i.e&#x2e;, a Node that supports exposing <a href="qtremoteobjects-source.html#source">Source</a> objects on the QtRO network) with address <i>address</i>. If set, <i>registryAddress</i> will be used to connect to the <a href="qremoteobjectregistry.html">QRemoteObjectRegistry</a> at the provided address. The <i>allowedSchemas</i> parameter is only needed (and should be set to <a href="qremoteobjecthostbase.html#AllowedSchemas-enum">AllowExternalRegistration</a>) if the schema of the url should be used as an <a href="qtremoteobjects-external-schemas.html#external-schemas">External Schema</a> by the registry.</p>
<p><b>See also </b><a href="qremoteobjecthost.html#setHostUrl">setHostUrl</a>, (), and <a href="qremoteobjectnode.html#registryUrl-prop">setRegistryUrl</a>().</p>
<!-- @@@QRemoteObjectHost -->
<!-- $$$QRemoteObjectHost$$$QRemoteObjectHostconstQUrl&QObject* -->
<h3 class="fn" id="QRemoteObjectHost-2"><a name="QRemoteObjectHost-2"></a>QRemoteObjectHost::<span class="name">QRemoteObjectHost</span>(const <span class="type">QUrl</span> &amp;<i>address</i>, <span class="type">QObject</span> *<i>parent</i>)</h3>
<p>Constructs a new <a href="qremoteobjecthost.html">QRemoteObjectHost</a> Node (i.e&#x2e;, a Node that supports exposing <a href="qtremoteobjects-source.html#source">Source</a> objects on the QtRO network) with a url of <i>address</i> and the given <i>parent</i>. This overload is provided as a convenience for specifying a QObject parent without providing a registry address.</p>
<p><b>See also </b><a href="qremoteobjecthost.html#setHostUrl">setHostUrl</a>() and <a href="qremoteobjectnode.html#registryUrl-prop">setRegistryUrl</a>().</p>
<!-- @@@QRemoteObjectHost -->
<!-- $$$~QRemoteObjectHost[overload1]$$$~QRemoteObjectHost -->
<h3 class="fn" id="dtor.QRemoteObjectHost"><a name="dtor.QRemoteObjectHost"></a><code>[override virtual] </code>QRemoteObjectHost::<span class="name">~QRemoteObjectHost</span>()</h3>
<p>Destroys the instance of QRemoteObjectHost. The destructor is virtual.</p><!-- @@@~QRemoteObjectHost -->
<!-- $$$hostUrl[overload1]$$$hostUrl -->
<h3 class="fn" id="hostUrl"><a name="hostUrl"></a><code>[override virtual] </code><span class="type">QUrl</span> QRemoteObjectHost::<span class="name">hostUrl</span>() const</h3>
<p>Returns the host address for the <a href="qremoteobjectnode.html">QRemoteObjectNode</a> as a QUrl. If the Node is not a Host node, it return an empty QUrl.</p>
<p><b>See also </b><a href="qremoteobjecthost.html">setHostUrl</a> and ().</p>
<!-- @@@hostUrl -->
<!-- $$$setHostUrl[overload1]$$$setHostUrlconstQUrl&QRemoteObjectHostBase::AllowedSchemas -->
<h3 class="fn" id="setHostUrl"><a name="setHostUrl"></a><code>[override virtual] </code><span class="type">bool</span> QRemoteObjectHost::<span class="name">setHostUrl</span>(const <span class="type">QUrl</span> &amp;<i>hostAddress</i>, <span class="type"><a href="qremoteobjecthostbase.html#AllowedSchemas-enum">QRemoteObjectHostBase::AllowedSchemas</a></span> <i>allowedSchemas</i> = BuiltInSchemasOnly)</h3>
<p>Sets the <i>hostAddress</i> for a host <a href="qremoteobjectnode.html">QRemoteObjectNode</a>.</p>
<p>Returns <code>true</code> if the Host address is set, otherwise <code>false</code>.</p>
<p>The <i>allowedSchemas</i> parameter is only needed (and should be set to <a href="qremoteobjecthostbase.html#AllowedSchemas-enum">AllowExternalRegistration</a>) if the schema of the url should be used as an <a href="qtremoteobjects-external-schemas.html#external-schemas">External Schema</a> by the registry.</p>
<p><b>See also </b><a href="qremoteobjecthost.html#hostUrl">hostUrl</a>().</p>
<!-- @@@setHostUrl -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2019 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    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.<br/>    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. </p>
</div>
</body>
</html>