/usr/share/gtk-doc/html/libepc-1.0/EpcProtocol.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 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EpcProtocol</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="consuming.html" title="Consuming">
<link rel="prev" href="libepc-1.0-consumer.html" title="EpcConsumer">
<link rel="next" href="publishing.html" title="Publishing">
<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-consumer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="consuming.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="publishing.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EpcProtocol.synopsis" class="shortcut">Top</a>
|
<a href="#EpcProtocol.description" class="shortcut">Description</a>
|
<a href="#EpcProtocol.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="EpcProtocol"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EpcProtocol.top_of_page"></a>EpcProtocol</span></h2>
<p>EpcProtocol — transport protocols</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EpcProtocol.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="EpcProtocol.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libepc/protcol.h>
enum <a class="link" href="EpcProtocol.html#EpcProtocol-enum" title="enum EpcProtocol">EpcProtocol</a>;
<a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="returnvalue">EpcProtocol</span></a> <a class="link" href="EpcProtocol.html#epc-protocol-from-name" title="epc_protocol_from_name ()">epc_protocol_from_name</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> fallback</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="EpcProtocol.html#epc-protocol-build-uri" title="epc_protocol_build_uri ()">epc_protocol_build_uri</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> *hostname</code></em>,
<em class="parameter"><code><span class="type">guint16</span> port</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EpcProtocol.html#epc-protocol-get-service-type" title="epc_protocol_get_service_type ()">epc_protocol_get_service_type</a> (<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> protocol</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EpcProtocol.html#epc-protocol-get-uri-scheme" title="epc_protocol_get_uri_scheme ()">epc_protocol_get_uri_scheme</a> (<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> protocol</code></em>);
<span class="returnvalue">GEnumClass</span> * <a class="link" href="EpcProtocol.html#epc-protocol-get-class" title="epc_protocol_get_class ()">epc_protocol_get_class</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="EpcProtocol.html#epc-protocol-to-string" title="epc_protocol_to_string ()">epc_protocol_to_string</a> (<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> value</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EpcProtocol.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GEnum
+----EpcProtocol
</pre>
</div>
<div class="refsect1">
<a name="EpcProtocol.description"></a><h2>Description</h2>
<p>
Since the Easy Publish and Consume library hides the details of the
transport mechanism used, it is possible to support different mechanisms.
Currently there is support for HTTP and HTTPS.
</p>
<p>
The <a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> enumeration is the maximum of information libepc wants to
expose regarding its transport mechanisms.
</p>
</div>
<div class="refsect1">
<a name="EpcProtocol.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EpcProtocol-enum"></a><h3>enum EpcProtocol</h3>
<pre class="programlisting">typedef enum {
EPC_PROTOCOL_UNKNOWN,
EPC_PROTOCOL_HTTP,
EPC_PROTOCOL_HTTPS
} EpcProtocol;
</pre>
<p>
The transport protocols supported by libepc.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="EPC-PROTOCOL-UNKNOWN:CAPS"></a><span class="term"><code class="literal">EPC_PROTOCOL_UNKNOWN</code></span></p></td>
<td>Used when the transport protocol is not known yet.
</td>
</tr>
<tr>
<td><p><a name="EPC-PROTOCOL-HTTP:CAPS"></a><span class="term"><code class="literal">EPC_PROTOCOL_HTTP</code></span></p></td>
<td>Plain HTTP. Passwords are protected using HTTP digest
authentication, remaining data is transfered without any encryption.
</td>
</tr>
<tr>
<td><p><a name="EPC-PROTOCOL-HTTPS:CAPS"></a><span class="term"><code class="literal">EPC_PROTOCOL_HTTPS</code></span></p></td>
<td>Encrypted HTTP. Attempts are made to use this
transport method when ever possible.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-protocol-from-name"></a><h3>epc_protocol_from_name ()</h3>
<pre class="programlisting"><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="returnvalue">EpcProtocol</span></a> epc_protocol_from_name (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> fallback</code></em>);</pre>
<p>
Parses the protocol <em class="parameter"><code>name</code></em>. Case of the name doesn't matter. Returns the
matching <a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a>, when the name was recognized, and the value of
<em class="parameter"><code>fallback</code></em> otherwise.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>a protocol name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fallback</code></em> :</span></p></td>
<td>the <a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> to use on errors</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> matching <em class="parameter"><code>name</code></em>, or <em class="parameter"><code>fallback</code></em> on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-protocol-build-uri"></a><h3>epc_protocol_build_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> * epc_protocol_build_uri (<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> *hostname</code></em>,
<em class="parameter"><code><span class="type">guint16</span> port</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
<p>
Builds the Unified Resource Identifier (URI) for a service.
The returned string 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>hostname</code></em> :</span></p></td>
<td>the host to contact</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>port</code></em> :</span></p></td>
<td>the service port</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>the service path, 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 with the URI for the service,
or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-protocol-get-service-type"></a><h3>epc_protocol_get_service_type ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * epc_protocol_get_service_type (<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> protocol</code></em>);</pre>
<p>
Queries the DNS-SD service type associated with a <a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a>.
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>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"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Returns the DNS-SD service type associated
with <em class="parameter"><code>protocol</code></em>, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> on unknown protocols.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-protocol-get-uri-scheme"></a><h3>epc_protocol_get_uri_scheme ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * epc_protocol_get_uri_scheme (<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> protocol</code></em>);</pre>
<p>
Queries the URI scheme associated with a <a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a>.
See <code class="function">epc_service_type_build_uri()</code>.
</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"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Returns the URI scheme associated with <em class="parameter"><code>protocol</code></em>,
or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a> on unknown protocols.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-protocol-get-class"></a><h3>epc_protocol_get_class ()</h3>
<pre class="programlisting"><span class="returnvalue">GEnumClass</span> * epc_protocol_get_class (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Retrieves the GEnumClass describing the EpcProtocol enum.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The GEnumClass describing EpcProtocol.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="epc-protocol-to-string"></a><h3>epc_protocol_to_string ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * epc_protocol_to_string (<em class="parameter"><code><a class="link" href="EpcProtocol.html" title="EpcProtocol"><span class="type">EpcProtocol</span></a> value</code></em>);</pre>
<p>
Retrieves the name of a EpcProtocol <em class="parameter"><code>value</code></em>, 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>value</code></em> is invalid.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a EpcProtocol value</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The string representation of <em class="parameter"><code>value</code></em>, or <a href="/opt/gnome/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL--CAPS"><code class="literal">NULL</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="EpcProtocol.see-also"></a><h2>See Also</h2>
epc_service_type_new()
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18.1</div>
</body>
</html>
|