/usr/share/gtk-doc/html/libinfinity-0.6/libinfinity-0.6-InfProtocol.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfProtocol: 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="libinfinity-0.6-InfError.html" title="InfError">
<link rel="next" href="libinfinity-0.6-InfNativeSocket.html" title="InfNativeSocket">
<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="#libinfinity-0.6-InfProtocol.description" class="shortcut">Description</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="libinfinity-0.6-InfError.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libinfinity-0.6-InfNativeSocket.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libinfinity-0.6-InfProtocol"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinfinity-0.6-InfProtocol.top_of_page"></a>InfProtocol</span></h2>
<p>InfProtocol — Infinote protocol parameters</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libinfinity-0.6-InfProtocol.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfProtocol.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">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libinfinity-0.6-InfProtocol.html#inf-protocol-get-version" title="inf_protocol_get_version ()">inf_protocol_get_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinity-0.6-InfProtocol.html#inf-protocol-parse-version" title="inf_protocol_parse_version ()">inf_protocol_parse_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libinfinity-0.6-InfProtocol.html#inf-protocol-get-default-port" title="inf_protocol_get_default_port ()">inf_protocol_get_default_port</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfProtocol.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-protocol.h>
</pre>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfProtocol.description"></a><h2>Description</h2>
<p>This section defines common protocol parameters used by libinfinity.</p>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfProtocol.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-protocol-get-version"></a><h3>inf_protocol_get_version ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
inf_protocol_get_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the version of the Infinote protocol implemented by this
version of libinfinity.</p>
<div class="refsect3">
<a name="id-1.3.34.7.2.5"></a><h4>Returns</h4>
<p> The supported infinote version.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-protocol-parse-version"></a><h3>inf_protocol_parse_version ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
inf_protocol_parse_version (<em class="parameter"><code>const <span class="type">gchar</span> *version</code></em>,
<em class="parameter"><code><span class="type">guint</span> *major</code></em>,
<em class="parameter"><code><span class="type">guint</span> *minor</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Splits the given version string into it's major and minor version number.
If the string is badly formatted then the function returns <code class="literal">FALSE</code>, <em class="parameter"><code>error</code></em>
is set and <em class="parameter"><code>major</code></em>
and <em class="parameter"><code>minor</code></em>
are left untouched.</p>
<p>It is guaranteed that, if <em class="parameter"><code>version</code></em>
is <a class="link" href="libinfinity-0.6-InfProtocol.html#inf-protocol-get-version" title="inf_protocol_get_version ()"><code class="function">inf_protocol_get_version()</code></a>, the
function does not fail.</p>
<div class="refsect3">
<a name="id-1.3.34.7.3.6"></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>version</p></td>
<td class="parameter_description"><p>A version string, such as "1.0"</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>major</p></td>
<td class="parameter_description"><p>A location to store the major version number to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minor</p></td>
<td class="parameter_description"><p>A location to store the minor version number to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.34.7.3.7"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, or <code class="literal">FALSE</code> on error.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-protocol-get-default-port"></a><h3>inf_protocol_get_default_port ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
inf_protocol_get_default_port (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the default port on which the infinote daemon listens for new
connections.</p>
<div class="refsect3">
<a name="id-1.3.34.7.4.5"></a><h4>Returns</h4>
<p> The default port.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfProtocol.other_details"></a><h2>Types and Values</h2>
</div>
<div class="refsect1">
<a name="libinfinity-0.6-InfProtocol.see-also"></a><h2>See Also</h2>
<a class="link" href="libinfinity-0.6-InfError.html" title="InfError">InfError</a>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|