libinfinity-0.6-doc 0.6.7-1build1 / usr / share / gtk-doc / html / libinfinity-0.6 / InfLocalPublisher.html

This file is indexed.

/usr/share/gtk-doc/html/libinfinity-0.6/InfLocalPublisher.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
<!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: 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="InfDiscovery.html" title="InfDiscovery">
<link rel="next" href="InfIpAddress.html" title="InfIpAddress">
<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="#InfLocalPublisher.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#InfLocalPublisher.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
                  <a href="#InfLocalPublisher.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations">  <span class="dim">|</span> 
                  <a href="#InfLocalPublisher.implementations" class="shortcut">Known Implementations</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="InfDiscovery.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfIpAddress.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfLocalPublisher.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="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem"><span class="returnvalue">InfLocalPublisherItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfLocalPublisher.html#inf-local-publisher-publish" title="inf_local_publisher_publish ()">inf_local_publisher_publish</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="InfLocalPublisher.html#inf-local-publisher-unpublish" title="inf_local_publisher_unpublish ()">inf_local_publisher_unpublish</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.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"> </td>
<td class="function_name"><a class="link" href="InfLocalPublisher.html#InfLocalPublisher-struct" title="InfLocalPublisher">InfLocalPublisher</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfLocalPublisher.html#InfLocalPublisherIface" title="struct InfLocalPublisherIface">InfLocalPublisherIface</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="InfLocalPublisher.html#InfLocalPublisherItem" title="InfLocalPublisherItem">InfLocalPublisherItem</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GInterface
    <span class="lineart">╰──</span> 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.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libinfinity/common/inf-local-publisher.h&gt;
</pre>
</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.functions_details"></a><h2>Functions</h2>
<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="refsect3">
<a name="id-1.3.15.10.2.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>publisher</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p>The service type to publish, such as _http._tcp.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>name</p></td>
<td class="parameter_description"><p>The name of the service.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>port</p></td>
<td class="parameter_description"><p>The port the service is listening on.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.15.10.2.6"></a><h4>Returns</h4>
<p> 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.</p>
</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="refsect3">
<a name="id-1.3.15.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>publisher</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfLocalPublisher.html" title="InfLocalPublisher"><span class="type">InfLocalPublisher</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item</p></td>
<td class="parameter_description"><p>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>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.other_details"></a><h2>Types and Values</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="refsect3">
<a name="id-1.3.15.11.3.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfLocalPublisherIface.publish"></a>publish</code></em> ()</p></td>
<td class="struct_member_description"><p>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.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfLocalPublisherIface.unpublish"></a>unpublish</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to unpublish a previously published service.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</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>
</div>
<div class="refsect1">
<a name="InfLocalPublisher.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfDiscoveryAvahi.html" title="InfDiscoveryAvahi"><span class="type">InfDiscoveryAvahi</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.