/usr/share/gtk-doc/html/libinfinity-0.6/InfDiscoveryAvahi.html is in libinfinity-0.6-doc 0.6.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfDiscoveryAvahi: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch02.html" title="Common libinfinity API">
<link rel="prev" href="InfSimulatedConnection.html" title="InfSimulatedConnection">
<link rel="next" href="InfXmppManager.html" title="InfXmppManager">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#InfDiscoveryAvahi.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfDiscoveryAvahi.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfDiscoveryAvahi.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfDiscoveryAvahi.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfSimulatedConnection.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfXmppManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfDiscoveryAvahi"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfDiscoveryAvahi.top_of_page"></a>InfDiscoveryAvahi</span></h2>
<p>InfDiscoveryAvahi — Service Discovery via Avahi</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="returnvalue">InfDiscoveryAvahi</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfDiscoveryAvahi.html#inf-discovery-avahi-new" title="inf_discovery_avahi_new ()">inf_discovery_avahi_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfDiscoveryAvahi.html#inf-discovery-avahi-set-security-policy" title="inf_discovery_avahi_set_security_policy ()">inf_discovery_avahi_set_security_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="returnvalue">InfXmppConnectionSecurityPolicy</span></a>
</td>
<td class="function_name">
<a class="link" href="InfDiscoveryAvahi.html#inf-discovery-avahi-get-security-policy" title="inf_discovery_avahi_get_security_policy ()">inf_discovery_avahi_get_security_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *</td>
<td class="property_name"><a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--credentials" title="The “credentials” property">credentials</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *</td>
<td class="property_name"><a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--io" title="The “io” property">io</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *</td>
<td class="property_name"><a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--sasl-context" title="The “sasl-context” property">sasl-context</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--sasl-mechanisms" title="The “sasl-mechanisms” property">sasl-mechanisms</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a></td>
<td class="property_name"><a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--security-policy" title="The “security-policy” property">security-policy</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *</td>
<td class="property_name"><a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--xmpp-manager" title="The “xmpp-manager” property">xmpp-manager</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi-struct" title="struct InfDiscoveryAvahi">InfDiscoveryAvahi</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahiClass" title="struct InfDiscoveryAvahiClass">InfDiscoveryAvahiClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfDiscoveryAvahi
</pre>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfDiscoveryAvahi implements
<a class="link" href="InfDiscovery.html" title="InfDiscovery">InfDiscovery</a> and <a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher">InfLocalPublisher</a>.</p>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-discovery-avahi.h>
</pre>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.description"></a><h2>Description</h2>
<p><a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a> implements the <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a> and <a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a>
interfaces on top of avahi. It resolves services to client-side
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>s.</p>
<p>This class is only available if the macro
<code class="literal">LIBINFINITY_HAVE_AVAHI</code> is defined.</p>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-discovery-avahi-new"></a><h3>inf_discovery_avahi_new ()</h3>
<pre class="programlisting"><a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="returnvalue">InfDiscoveryAvahi</span></a> *
inf_discovery_avahi_new (<em class="parameter"><code><a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *io</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *manager</code></em>,
<em class="parameter"><code><a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *creds</code></em>,
<em class="parameter"><code><a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *sasl_context</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *sasl_mechanisms</code></em>);</pre>
<p>Created a new <a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a> object which can be used to publish and
discovery Infinote services on the local network. When resolving a
<a class="link" href="InfDiscovery.html#InfDiscoveryInfo" title="InfDiscoveryInfo"><span class="type">InfDiscoveryInfo</span></a> (which means obtaining a <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> for the
discovered service) a new <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> needs to be created if there
is not already one for the destination host in <em class="parameter"><code>manager</code></em>
. Such
connections are created with the <em class="parameter"><code>creds</code></em>
and <em class="parameter"><code>sasl_context</code></em>
parameters.
These may be <code class="literal">NULL</code> in which case <a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a> uses builtin
credentials or a builtin context, respectively.</p>
<p>If this <a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a> is not used to discover services but only to
publish any, then <em class="parameter"><code>creds</code></em>
, <em class="parameter"><code>sasl_context</code></em>
and <em class="parameter"><code>sasl_mechanisms</code></em>
are ignored
and can safely set to be <code class="literal">NULL</code>.</p>
<p><em class="parameter"><code>sasl_mechanisms</code></em>
specifies allowed mechanisms used for authentication with
the server. It can be <code class="literal">NULL</code>, in which case all available mechanisms are
accepted.</p>
<div class="refsect3">
<a name="id-1.3.22.10.2.7"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>io</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object used for watching sockets and timeouts.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>manager</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>creds</p></td>
<td class="parameter_description"><p>The certificate credentials used for GnuTLS encryption.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sasl_context</p></td>
<td class="parameter_description"><p>A SASL context used for authentication.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sasl_mechanisms</p></td>
<td class="parameter_description"><p>A whitespace-separated list of accepted SASL mechanisms,
or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.22.10.2.8"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-discovery-avahi-set-security-policy"></a><h3>inf_discovery_avahi_set_security_policy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_discovery_avahi_set_security_policy
(<em class="parameter"><code><a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a> *discovery</code></em>,
<em class="parameter"><code><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> plcy</code></em>);</pre>
<p>Sets the <a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> for newly created
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>s. It does not affect already existing
connections.</p>
<div class="refsect3">
<a name="id-1.3.22.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>discovery</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>plcy</p></td>
<td class="parameter_description"><p>The new security policy.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-discovery-avahi-get-security-policy"></a><h3>inf_discovery_avahi_get_security_policy ()</h3>
<pre class="programlisting"><a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="returnvalue">InfXmppConnectionSecurityPolicy</span></a>
inf_discovery_avahi_get_security_policy
(<em class="parameter"><code><a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a> *discovery</code></em>);</pre>
<p>Returns the current security policy used for new
<a class="link" href="InfXmppConnection.html" title="InfXmppConnection"><span class="type">InfXmppConnection</span></a>s.</p>
<div class="refsect3">
<a name="id-1.3.22.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>discovery</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.22.10.4.6"></a><h4>Returns</h4>
<p> The current security policy.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfDiscoveryAvahi-struct"></a><h3>struct InfDiscoveryAvahi</h3>
<pre class="programlisting">struct InfDiscoveryAvahi;</pre>
<p><a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a> is an opaque data type. You should only access it
via the public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscoveryAvahiClass"></a><h3>struct InfDiscoveryAvahiClass</h3>
<pre class="programlisting">struct InfDiscoveryAvahiClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfDiscoveryAvahi--credentials"></a><h3>The <code class="literal">“credentials”</code> property</h3>
<pre class="programlisting"> “credentials” <a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a> *</pre>
<p>The GnuTLS certificate credentials used for encrypting XMPP streams.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscoveryAvahi--io"></a><h3>The <code class="literal">“io”</code> property</h3>
<pre class="programlisting"> “io” <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> *</pre>
<p>The IO object used for watching sockets and timeouts.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscoveryAvahi--sasl-context"></a><h3>The <code class="literal">“sasl-context”</code> property</h3>
<pre class="programlisting"> “sasl-context” <a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a> *</pre>
<p>The SASL context used for authentication.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscoveryAvahi--sasl-mechanisms"></a><h3>The <code class="literal">“sasl-mechanisms”</code> property</h3>
<pre class="programlisting"> “sasl-mechanisms” <span class="type">gchar</span> *</pre>
<p>The accepted SASL mechanisms for authentication.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscoveryAvahi--security-policy"></a><h3>The <code class="literal">“security-policy”</code> property</h3>
<pre class="programlisting"> “security-policy” <a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy" title="enum InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a></pre>
<p>How to decide whether to use TLS.</p>
<p>Flags: Read / Write</p>
<p>Default value: INF_XMPP_CONNECTION_SECURITY_BOTH_PREFER_TLS</p>
</div>
<hr>
<div class="refsect2">
<a name="InfDiscoveryAvahi--xmpp-manager"></a><h3>The <code class="literal">“xmpp-manager”</code> property</h3>
<pre class="programlisting"> “xmpp-manager” <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a> *</pre>
<p>The XMPP manager to register resolved XMPP connections.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>, <a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|