/usr/share/gtk-doc/html/libinfinity-0.5/InfLocalPublisher.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfLocalPublisher</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="InfDiscovery.html" title="InfDiscovery">
<link rel="next" href="InfIpAddress.html" title="InfIpAddress">
<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="InfDiscovery.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="InfIpAddress.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfLocalPublisher.synopsis" class="shortcut">Top</a>
|
<a href="#InfLocalPublisher.description" class="shortcut">Description</a>
|
<a href="#InfLocalPublisher.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#InfLocalPublisher.prerequisites" class="shortcut">Prerequisites</a>
|
<a href="#InfLocalPublisher.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="InfLocalPublisher"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfLocalPublisher.top_of_page"></a>InfLocalPublisher</span></h2>
<p>InfLocalPublisher — Publish services on the local network</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="InfLocalPublisher.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libinfinity/common/inf-local-publisher.h>
<a class="link" href="InfLocalPublisher.html#InfLocalPublisher-struct" title="InfLocalPublisher">InfLocalPublisher</a>;
struct <a class="link" href="InfLocalPublisher.html#InfLocalPublisherIface" title="struct InfLocalPublisherIface">InfLocalPublisherIface</a>;
<a class="link" href="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem">InfLocalPublisherItem</a>;
<a class="link" href="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem"><span class="returnvalue">InfLocalPublisherItem</span></a> * <a class="link" href="InfLocalPublisher.html#inf-local-publisher-publish" title="inf_local_publisher_publish ()">inf_local_publisher_publish</a> (<em class="parameter"><code><a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a> *publisher</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *type</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">guint</span> port</code></em>);
<span class="returnvalue">void</span> <a class="link" href="InfLocalPublisher.html#inf-local-publisher-unpublish" title="inf_local_publisher_unpublish ()">inf_local_publisher_unpublish</a> (<em class="parameter"><code><a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a> *publisher</code></em>,
<em class="parameter"><code><a class="link" href="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem"><span class="type">InfLocalPublisherItem</span></a> *item</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----InfLocalPublisher
</pre>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.prerequisites"></a><h2>Prerequisites</h2>
<p>
InfLocalPublisher requires
GObject.</p>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.implementations"></a><h2>Known Implementations</h2>
<p>
InfLocalPublisher is implemented by
<a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi">InfDiscoveryAvahi</a>.</p>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.description"></a><h2>Description</h2>
<p>
<a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a> provides a common interface to publish services on the
local network.
</p>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="InfLocalPublisher-struct"></a><h3>InfLocalPublisher</h3>
<pre class="programlisting">typedef struct _InfLocalPublisher InfLocalPublisher;</pre>
<p>
<a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</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="InfLocalPublisherIface"></a><h3>struct InfLocalPublisherIface</h3>
<pre class="programlisting">struct InfLocalPublisherIface {
InfLocalPublisherItem* (*publish)(InfLocalPublisher* publisher,
const gchar* type,
const gchar* name,
guint port);
void (*unpublish)(InfLocalPublisher* publisher,
InfLocalPublisherItem* item);
};
</pre>
<p>
Virtual functions for <a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a>.
</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="structfield"><code><a name="InfLocalPublisherIface.publish"></a>publish</code></em> ()</span></p></td>
<td>Virtual function to announce a service of the given type with
the given name on the given port. The returned <a class="link" href="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem"><span class="type">InfLocalPublisherItem</span></a> is
valid as long as the service is published and the <a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a> is
alive. It can be used to unpublish the service again using the <em class="parameter"><code>unpublish</code></em>
function.</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="InfLocalPublisherIface.unpublish"></a>unpublish</code></em> ()</span></p></td>
<td>Virtual function to unpublish a previously published service.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="InfLocalPublisherItem"></a><h3>InfLocalPublisherItem</h3>
<pre class="programlisting">typedef struct _InfLocalPublisherItem InfLocalPublisherItem;</pre>
<p>
<a class="link" href="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem"><span class="type">InfLocalPublisherItem</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="inf-local-publisher-publish"></a><h3>inf_local_publisher_publish ()</h3>
<pre class="programlisting"><a class="link" href="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem"><span class="returnvalue">InfLocalPublisherItem</span></a> * inf_local_publisher_publish (<em class="parameter"><code><a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a> *publisher</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *type</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><span class="type">guint</span> port</code></em>);</pre>
<p>
Publishes a service through <em class="parameter"><code>publisher</code></em> so that it can be discovered with
an appropriate <a class="link" href="InfDiscovery.html" title="InfDiscovery"><span class="type">InfDiscovery</span></a>.
</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>publisher</code></em> :</span></p></td>
<td>A <a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>The service type to publish, such as _http._tcp.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The name of the service.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>port</code></em> :</span></p></td>
<td>The port the service is listening on.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem"><span class="type">InfLocalPublisherItem</span></a> that can be used to unpublish
the service again.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-local-publisher-unpublish"></a><h3>inf_local_publisher_unpublish ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_local_publisher_unpublish (<em class="parameter"><code><a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a> *publisher</code></em>,
<em class="parameter"><code><a class="link" href="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem"><span class="type">InfLocalPublisherItem</span></a> *item</code></em>);</pre>
<p>
Unpublishes <em class="parameter"><code>item</code></em> so that it can no longer be found in the network.
</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>publisher</code></em> :</span></p></td>
<td>A <a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td>A published item obtained from <a class="link" href="InfLocalPublisher.html#inf-local-publisher-publish" title="inf_local_publisher_publish ()"><code class="function">inf_local_publisher_publish()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.see-also"></a><h2>See Also</h2>
<a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|