/usr/share/gtk-doc/html/libepc-1.0/libepc-1.0-EpcServiceType.html is in libepc-doc 0.4.3-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EpcServiceType</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Easy Publish and Consume Reference Manual">
<link rel="up" href="dns-sd-support.html" title="DNS-SD Support">
<link rel="prev" href="libepc-1.0-service-monitor.html" title="EpcServiceMonitor">
<link rel="next" href="widgets.html" title="Widgets">
<meta name="generator" content="GTK-Doc V1.18.1 (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="libepc-1.0-service-monitor.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="dns-sd-support.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">Easy Publish and Consume Reference Manual</th>
<td><a accesskey="n" href="widgets.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libepc-1.0-EpcServiceType.synopsis" class="shortcut">Top</a>
|
<a href="#libepc-1.0-EpcServiceType.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libepc-1.0-EpcServiceType"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libepc-1.0-EpcServiceType.top_of_page"></a>EpcServiceType</span></h2>
<p>EpcServiceType — service type details</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libepc-1.0-EpcServiceType.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libepc-1.0-EpcServiceType.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libepc/service-type.h>
#define <a class="link" href="libepc-1.0-EpcServiceType.html#EPC-SERVICE-TYPE-HTTP:CAPS" title="EPC_SERVICE_TYPE_HTTP">EPC_SERVICE_TYPE_HTTP</a>
#define <a class="link" href="libepc-1.0-EpcServiceType.html#EPC-SERVICE-TYPE-HTTPS:CAPS" title="EPC_SERVICE_TYPE_HTTPS">EPC_SERVICE_TYPE_HTTPS</a>
const <span class="returnvalue">gchar</span> * <a class="link" href="libepc-1.0-EpcServiceType.html#epc-service-type-get-base" title="epc_service_type_get_base ()">epc_service_type_get_base</a> (<em class="parameter"><code>const <span class="type">gchar</span> *type</code></em>);
<a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="returnvalue">EpcProtocol</span></a> <a class="link" href="libepc-1.0-EpcServiceType.html#epc-service-type-get-protocol" title="epc_service_type_get_protocol ()">epc_service_type_get_protocol</a> (<em class="parameter"><code>const <span class="type">gchar</span> *service_type</code></em>);
<span class="returnvalue">gchar</span> ** <a class="link" href="libepc-1.0-EpcServiceType.html#epc-service-type-list-supported" title="epc_service_type_list_supported ()">epc_service_type_list_supported</a> (<em class="parameter"><code>const <span class="type">gchar</span> *application</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="libepc-1.0-EpcServiceType.html#epc-service-type-new" title="epc_service_type_new ()">epc_service_type_new</a> (<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> protocol</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *application</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libepc-1.0-EpcServiceType.description"></a><h2>Description</h2>
<p>
DNS-SD uses well-known services types to discover service providers.
The following macros describe the service types uses by this library.
</p>
<p>
</p>
<div class="example">
<a name="find-publisher"></a><p class="title"><b>Example 9. Find an Easy-Publish server</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal">dialog </span><span class="symbol">=</span><span class="normal"> </span><span class="function">aui_service_dialog_new</span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Choose an Easy Publish Server"</span><span class="symbol">,</span><span class="normal"> <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">,</span>
<span class="normal"> GTK_STOCK_CANCEL</span><span class="symbol">,</span><span class="normal"> GTK_RESPONSE_CANCEL</span><span class="symbol">,</span>
<span class="normal"> GTK_STOCK_CONNECT</span><span class="symbol">,</span><span class="normal"> GTK_RESPONSE_ACCEPT</span><span class="symbol">,</span>
<span class="normal"> <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span>
<span class="function">aui_service_dialog_set_browse_service_types</span><span class="normal"> </span><span class="symbol">(</span><span class="function">AUI_SERVICE_DIALOG</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">dialog</span><span class="symbol">),</span>
<span class="normal"> <a href="libepc-1.0-EpcServiceType.html#EPC-SERVICE-TYPE-HTTPS:CAPS">EPC_SERVICE_TYPE_HTTPS</a></span><span class="symbol">,</span>
<span class="normal"> <a href="libepc-1.0-EpcServiceType.html#EPC-SERVICE-TYPE-HTTP:CAPS">EPC_SERVICE_TYPE_HTTP</a></span><span class="symbol">,</span>
<span class="normal"> <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS">NULL</a></span><span class="symbol">);</span>
<span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">GTK_RESPONSE_ACCEPT </span><span class="symbol">==</span><span class="normal"> </span><span class="function">gtk_dialog_run</span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_DIALOG</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">dialog</span><span class="symbol">)))</span>
<span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">gint</span><span class="normal"> port </span><span class="symbol">=</span><span class="normal"> </span><span class="function">aui_service_dialog_get_port</span><span class="normal"> </span><span class="symbol">(</span><span class="function">AUI_SERVICE_DIALOG</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">dialog</span><span class="symbol">));</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">host </span><span class="symbol">=</span><span class="normal"> </span><span class="function">aui_service_dialog_get_host_name</span><span class="normal"> </span><span class="symbol">(</span><span class="function">AUI_SERVICE_DIALOG</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">dialog</span><span class="symbol">));</span>
<span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">type </span><span class="symbol">=</span><span class="normal"> </span><span class="function">aui_service_dialog_get_service_type</span><span class="normal"> </span><span class="symbol">(</span><span class="function">AUI_SERVICE_DIALOG</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">dialog</span><span class="symbol">));</span>
<span class="normal"> </span><span class="usertype">EpcProtocol</span><span class="normal"> protocol </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="libepc-1.0-EpcServiceType.html#epc-service-type-get-protocol">epc_service_type_get_protocol</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">type</span><span class="symbol">);</span>
<span class="normal"> </span><span class="symbol">...</span>
<span class="normal"> </span><span class="cbracket">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<p><br class="example-break">
</p>
</div>
<div class="refsect1">
<a name="libepc-1.0-EpcServiceType.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EPC-SERVICE-TYPE-HTTP:CAPS"></a><h3>EPC_SERVICE_TYPE_HTTP</h3>
<pre class="programlisting">#define EPC_SERVICE_TYPE_HTTP "_easy-publish-http._tcp"
</pre>
<p>
The well-known DNS-SD service type for <a class="link" href="libepc-1.0-publisher.html#EpcPublisher"><span class="type">EpcPublisher</span></a>
servers providing unencrypted HTTP access.
</p>
</div>
<hr>
<div class="refsect2">
<a name="EPC-SERVICE-TYPE-HTTPS:CAPS"></a><h3>EPC_SERVICE_TYPE_HTTPS</h3>
<pre class="programlisting">#define EPC_SERVICE_TYPE_HTTPS "_easy-publish-https._tcp"
</pre>
<p>
The well-known DNS-SD service type for <a class="link" href="libepc-1.0-publisher.html#EpcPublisher"><span class="type">EpcPublisher</span></a>
servers providing encrypted HTTPS access.
</p>
</div>
<hr>
<div class="refsect2">
<a name="epc-service-type-get-base"></a><h3>epc_service_type_get_base ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * epc_service_type_get_base (<em class="parameter"><code>const <span class="type">gchar</span> *type</code></em>);</pre>
<p>
Extracts the base service-type of a DNS-SD service-type.
</p>
<p>
DNS-SD service types may contain a sub service type, for instance the
service-type "_anon._sub._ftp._tcp" contains the base-type "_ftp._tcp"
and the sub-type "_anon". This function extracts extracts the base-type.
The service type is returned unmodifed if it doesn't contain a sub-type.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a DNS-SD service-type</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The base-service-type.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-service-type-get-protocol"></a><h3>epc_service_type_get_protocol ()</h3>
<pre class="programlisting"><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="returnvalue">EpcProtocol</span></a> epc_service_type_get_protocol (<em class="parameter"><code>const <span class="type">gchar</span> *service_type</code></em>);</pre>
<p>
Queries the <a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> associated with a DNS-SD service type.
See <a class="link" href="libepc-1.0-EpcServiceType.html#EPC-SERVICE-TYPE-HTTP:CAPS" title="EPC_SERVICE_TYPE_HTTP"><span class="type">EPC_SERVICE_TYPE_HTTP</span></a>, <a class="link" href="libepc-1.0-EpcServiceType.html#EPC-SERVICE-TYPE-HTTPS:CAPS" title="EPC_SERVICE_TYPE_HTTPS"><span class="type">EPC_SERVICE_TYPE_HTTPS</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>service_type</code></em> :</span></p></td>
<td>a DNS-SD service type</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Returns the <a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> associated with <em class="parameter"><code>service_type</code></em>,
or <a class="link" href="EpcProtocol.html#EPC-PROTOCOL-UNKNOWN:CAPS"><span class="type">EPC_PROTOCOL_UNKNOWN</span></a> for unrecognized or unsupported service types.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-service-type-list-supported"></a><h3>epc_service_type_list_supported ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> ** epc_service_type_list_supported (<em class="parameter"><code>const <span class="type">gchar</span> *application</code></em>);</pre>
<p>
Lists all service types supported by the library. When <em class="parameter"><code>application</code></em> is <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
just the generic types, otherwise the service-subtypes for that application
are returned. The returned list is terminated by <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> and must be released
by the caller with <code class="function">g_strfreev()</code>.
</p>
<p>
See also: <a class="link" href="libepc-1.0-EpcServiceType.html#epc-service-type-new" title="epc_service_type_new ()"><code class="function">epc_service_type_new()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>application</code></em> :</span></p></td>
<td>an application name, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> terminated list of all supported service types.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-service-type-new"></a><h3>epc_service_type_new ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * epc_service_type_new (<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> protocol</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *application</code></em>);</pre>
<p>
Builds the DNS-SD service type for the given transport <em class="parameter"><code>protocol</code></em> and
application. When <em class="parameter"><code>application</code></em> is <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>, the application name is retrieved by
calling <code class="function">g_get_prgname()</code>. <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> is returned in that case if <code class="function">g_get_prgname()</code> returns <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.
</p>
<p>
The string returned should be released when no longer needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>protocol</code></em> :</span></p></td>
<td>a <a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>application</code></em> :</span></p></td>
<td>the application name, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated string holding the requested service-type,
or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> when <em class="parameter"><code>application</code></em> is <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> and <code class="function">g_get_prgname()</code> fails.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libepc-1.0-EpcServiceType.see-also"></a><h2>See Also</h2>
<a class="link" href="libepc-1.0-consumer.html#EpcConsumer"><span class="type">EpcConsumer</span></a>, <a class="link" href="libepc-1.0-publisher.html#EpcPublisher"><span class="type">EpcPublisher</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|