/usr/share/gtk-doc/html/libinfinity-0.6/InfAdoptedUser.html is in libinfinity-0.6-doc 0.6.7-1~deb8u1.
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 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libinfinity-0.6 Reference Manual: InfAdoptedUser</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch03.html" title="Libinfinity's adOPTed implementation">
<link rel="prev" href="InfAdoptedSplitOperation.html" title="InfAdoptedSplitOperation">
<link rel="next" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector">
<meta name="generator" content="GTK-Doc V1.21 (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="#InfAdoptedUser.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfAdoptedUser.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfAdoptedUser.properties" class="shortcut">Properties</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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfAdoptedSplitOperation.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfAdoptedStateVector.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfAdoptedUser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfAdoptedUser.top_of_page"></a>InfAdoptedUser</span></h2>
<p>InfAdoptedUser — User in a <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a>.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfAdoptedUser.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="InfAdoptedUser.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUser.html#inf-adopted-user-get-component" title="inf_adopted_user_get_component ()">inf_adopted_user_get_component</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="returnvalue">InfAdoptedStateVector</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUser.html#inf-adopted-user-get-vector" title="inf_adopted_user_get_vector ()">inf_adopted_user_get_vector</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="InfAdoptedUser.html#inf-adopted-user-set-vector" title="inf_adopted_user_set_vector ()">inf_adopted_user_set_vector</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="returnvalue">InfAdoptedRequestLog</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUser.html#inf-adopted-user-get-request-log" title="inf_adopted_user_get_request_log ()">inf_adopted_user_get_request_log</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedUser.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *</td>
<td class="property_name"><a class="link" href="InfAdoptedUser.html#InfAdoptedUser--request-log" title="The “request-log” property">request-log</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="type">InfAdoptedStateVector</span></a> *</td>
<td class="property_name"><a class="link" href="InfAdoptedUser.html#InfAdoptedUser--vector" title="The “vector” property">vector</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedUser.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table 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="InfAdoptedUser.html#InfAdoptedUser-struct" title="InfAdoptedUser">InfAdoptedUser</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfAdoptedUser.html#InfAdoptedUserClass" title="struct InfAdoptedUserClass">InfAdoptedUserClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedUser.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> <a class="link" href="InfUser.html" title="InfUser">InfUser</a>
<span class="lineart">╰──</span> InfAdoptedUser
</pre>
</div>
<div class="refsect1">
<a name="InfAdoptedUser.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/adopted/inf-adopted-user.h>
</pre>
</div>
<div class="refsect1">
<a name="InfAdoptedUser.description"></a><h2>Description</h2>
<p><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> is a <a class="link" href="InfUser.html" title="InfUser"><span class="type">InfUser</span></a>-derived class that is used in
<a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>. It holds all user-specific information that is needed
by <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> to handle the concurrency control. This includes
the user's request log which stores all the requests made by the user and
a state vector which specifies the document state that the user has, as
known to the local host. This information is extracted from the most recent
request received from the user.</p>
</div>
<div class="refsect1">
<a name="InfAdoptedUser.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-adopted-user-get-component"></a><h3>inf_adopted_user_get_component ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
inf_adopted_user_get_component (<em class="parameter"><code><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *user</code></em>,
<em class="parameter"><code><span class="type">guint</span> id</code></em>);</pre>
<p>Returns the amount of requests <em class="parameter"><code>user</code></em>
is guaranteed to have processed from
the user with ID <em class="parameter"><code>id</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.12.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>user</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>id</p></td>
<td class="parameter_description"><p>The component to retrieve.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.12.10.2.6"></a><h4>Returns</h4>
<p> The number of requests <em class="parameter"><code>user</code></em>
has processed from <em class="parameter"><code>id</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-user-get-vector"></a><h3>inf_adopted_user_get_vector ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="returnvalue">InfAdoptedStateVector</span></a> *
inf_adopted_user_get_vector (<em class="parameter"><code><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *user</code></em>);</pre>
<p>Returns the current vector time of <em class="parameter"><code>user</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.12.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>user</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.12.10.3.6"></a><h4>Returns</h4>
<p> The current vector time of <em class="parameter"><code>user</code></em>
.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-user-set-vector"></a><h3>inf_adopted_user_set_vector ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_user_set_vector (<em class="parameter"><code><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *user</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="type">InfAdoptedStateVector</span></a> *vec</code></em>);</pre>
<p>Updates the state vector of <em class="parameter"><code>user</code></em>
. This function takes ownership of <em class="parameter"><code>vec</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.12.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>user</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vec</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="type">InfAdoptedStateVector</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-user-get-request-log"></a><h3>inf_adopted_user_get_request_log ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="returnvalue">InfAdoptedRequestLog</span></a> *
inf_adopted_user_get_request_log (<em class="parameter"><code><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *user</code></em>);</pre>
<p>Returns the request log of <em class="parameter"><code>user</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.12.10.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>user</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.12.10.5.6"></a><h4>Returns</h4>
<p> User's <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a>.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedUser.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfAdoptedUser-struct"></a><h3>InfAdoptedUser</h3>
<pre class="programlisting">typedef struct _InfAdoptedUser InfAdoptedUser;</pre>
<p><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</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="InfAdoptedUserClass"></a><h3>struct InfAdoptedUserClass</h3>
<pre class="programlisting">struct InfAdoptedUserClass {
};
</pre>
<p>This structure does not contain any public fields.</p>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedUser.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfAdoptedUser--request-log"></a><h3>The <code class="literal">“request-log”</code> property</h3>
<pre class="programlisting"> “request-log” <a class="link" href="InfAdoptedRequestLog.html" title="InfAdoptedRequestLog"><span class="type">InfAdoptedRequestLog</span></a> *</pre>
<p>Request log of this user.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedUser--vector"></a><h3>The <code class="literal">“vector”</code> property</h3>
<pre class="programlisting"> “vector” <a class="link" href="InfAdoptedStateVector.html" title="InfAdoptedStateVector"><span class="type">InfAdoptedStateVector</span></a> *</pre>
<p>The state this user is currently at.</p>
<p>Flags: Read / Write</p>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedUser.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfAdoptedSession.html" title="InfAdoptedSession"><span class="type">InfAdoptedSession</span></a>, <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a></p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|