/usr/share/gtk-doc/html/libinfinity-0.5/InfDiscoveryAvahi.html is in libinfinity-0.5-doc 0.5.5-1.
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 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinfinity-0.5 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.19 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="InfSimulatedConnection.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.5 Reference Manual</th>
<td><a accesskey="n" href="InfXmppManager.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfDiscoveryAvahi.synopsis" class="shortcut">Top</a>
|
<a href="#InfDiscoveryAvahi.description" class="shortcut">Description</a>
|
<a href="#InfDiscoveryAvahi.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#InfDiscoveryAvahi.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#InfDiscoveryAvahi.properties" class="shortcut">Properties</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="InfDiscoveryAvahi.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libinfinity/common/inf-discovery-avahi.h>
<a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi-struct" title="InfDiscoveryAvahi">InfDiscoveryAvahi</a>;
struct <a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahiClass" title="struct InfDiscoveryAvahiClass">InfDiscoveryAvahiClass</a>;
<a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="returnvalue">InfDiscoveryAvahi</span></a> * <a class="link" href="InfDiscoveryAvahi.html#inf-discovery-avahi-new" title="inf_discovery_avahi_new ()">inf_discovery_avahi_new</a> (<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>);
<span class="returnvalue">void</span> <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>
(<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"><span class="type">InfXmppConnectionSecurityPolicy</span></a> plcy</code></em>);
<a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy"><span class="returnvalue">InfXmppConnectionSecurityPolicy</span></a> <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>
(<em class="parameter"><code><a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a> *discovery</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----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.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--credentials" title='The "credentials" property'>credentials</a>" <a class="link" href="InfCertificateCredentials.html" title="InfCertificateCredentials"><span class="type">InfCertificateCredentials</span></a>* : Read / Write / Construct
"<a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--io" title='The "io" property'>io</a>" <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a>* : Read / Write / Construct Only
"<a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--sasl-context" title='The "sasl-context" property'>sasl-context</a>" <a class="link" href="InfSaslContext.html" title="InfSaslContext"><span class="type">InfSaslContext</span></a>* : Read / Write / Construct
"<a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--sasl-mechanisms" title='The "sasl-mechanisms" property'>sasl-mechanisms</a>" <span class="type">gchar</span>* : Read / Write / Construct
"<a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--security-policy" title='The "security-policy" property'>security-policy</a>" <a class="link" href="InfXmppConnection.html#InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> : Read / Write
"<a class="link" href="InfDiscoveryAvahi.html#InfDiscoveryAvahi--xmpp-manager" title='The "xmpp-manager" property'>xmpp-manager</a>" <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>* : Read / Write / Construct Only
</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.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="InfDiscoveryAvahi-struct"></a><h3>InfDiscoveryAvahi</h3>
<pre class="programlisting">typedef struct _InfDiscoveryAvahi 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>
<hr>
<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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>io</code></em> :</span></p></td>
<td>A <a class="link" href="InfIo.html" title="InfIo"><span class="type">InfIo</span></a> object used for watching sockets and timeouts.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>manager</code></em> :</span></p></td>
<td>A <a class="link" href="InfXmppManager.html" title="InfXmppManager"><span class="type">InfXmppManager</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>creds</code></em> :</span></p></td>
<td>The certificate credentials used for GnuTLS encryption.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sasl_context</code></em> :</span></p></td>
<td>A SASL context used for authentication.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sasl_mechanisms</code></em> :</span></p></td>
<td>A whitespace-separated list of accepted SASL mechanisms,
or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a>.</td>
</tr>
</tbody>
</table></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"><span class="type">InfXmppConnectionSecurityPolicy</span></a> plcy</code></em>);</pre>
<p>
Sets the <a class="link" href="InfXmppConnection.html#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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>discovery</code></em> :</span></p></td>
<td>A <a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>plcy</code></em> :</span></p></td>
<td>The new security policy.</td>
</tr>
</tbody>
</table></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"><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="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>discovery</code></em> :</span></p></td>
<td>A <a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The current security policy.</td>
</tr>
</tbody>
</table></div>
</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>* : Read / Write / Construct</pre>
<p>The GnuTLS certificate credentials used for encrypting XMPP streams.</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>* : Read / Write / Construct Only</pre>
<p>The IO object used for watching sockets and timeouts.</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>* : Read / Write / Construct</pre>
<p>The SASL context used for authentication.</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>* : Read / Write / Construct</pre>
<p>The accepted SASL mechanisms for authentication.</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"><span class="type">InfXmppConnectionSecurityPolicy</span></a> : Read / Write</pre>
<p>How to decide whether to use TLS.</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>* : Read / Write / Construct Only</pre>
<p>The XMPP manager to register resolved XMPP connections.</p>
</div>
</div>
<div class="refsect1">
<a name="InfDiscoveryAvahi.see-also"></a><h2>See Also</h2>
<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>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|