/usr/share/gtk-doc/html/libinfinity-0.6/InfSessionProxy.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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfSessionProxy: 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="InfBrowserIter.html" title="InfBrowserIter">
<link rel="next" href="InfRequest.html" title="InfRequest">
<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="#InfSessionProxy.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfSessionProxy.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#InfSessionProxy.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#InfSessionProxy.implementations" class="shortcut">Known Implementations</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfSessionProxy.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfBrowserIter.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfRequest.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfSessionProxy"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfSessionProxy.top_of_page"></a>InfSessionProxy</span></h2>
<p>InfSessionProxy — Joining users into a session</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfSessionProxy.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="InfSessionProxy.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="InfRequest.html" title="InfRequest"><span class="returnvalue">InfRequest</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfSessionProxy.html#inf-session-proxy-join-user" title="inf_session_proxy_join_user ()">inf_session_proxy_join_user</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfSessionProxy.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" 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="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *</td>
<td class="property_name"><a class="link" href="InfSessionProxy.html#InfSessionProxy--session" title="The “session” property">session</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfSessionProxy.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="InfSessionProxy.html#InfSessionProxy-struct" title="InfSessionProxy">InfSessionProxy</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfSessionProxy.html#InfSessionProxyIface" title="struct InfSessionProxyIface">InfSessionProxyIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfSessionProxy.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GInterface
<span class="lineart">╰──</span> InfSessionProxy
</pre>
</div>
<div class="refsect1">
<a name="InfSessionProxy.prerequisites"></a><h2>Prerequisites</h2>
<p>
InfSessionProxy requires
GObject.</p>
</div>
<div class="refsect1">
<a name="InfSessionProxy.implementations"></a><h2>Known Implementations</h2>
<p>
InfSessionProxy is implemented by
<a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy">InfcSessionProxy</a> and <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy">InfdSessionProxy</a>.</p>
</div>
<div class="refsect1">
<a name="InfSessionProxy.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/common/inf-session_proxy.h>
</pre>
</div>
<div class="refsect1">
<a name="InfSessionProxy.description"></a><h2>Description</h2>
<p>A <a class="link" href="InfSessionProxy.html" title="InfSessionProxy"><span class="type">InfSessionProxy</span></a> is a network-architecture-aware layer on top of a
<a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>. A <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> has no idea about what kind of network it is in,
all it has is a possibility to send messages to one user or to all users.</p>
<p>A <a class="link" href="InfSessionProxy.html" title="InfSessionProxy"><span class="type">InfSessionProxy</span></a> implements the part of the infinote protocol which
depends on whether the session is at an infinote server or an infinote
client. This interface provides a method to join a user into a session so
that it does not need to be known to the caller whether the session at
hand is on a server or a client.</p>
</div>
<div class="refsect1">
<a name="InfSessionProxy.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-session-proxy-join-user"></a><h3>inf_session_proxy_join_user ()</h3>
<pre class="programlisting"><a class="link" href="InfRequest.html" title="InfRequest"><span class="returnvalue">InfRequest</span></a> *
inf_session_proxy_join_user (<em class="parameter"><code><a class="link" href="InfSessionProxy.html" title="InfSessionProxy"><span class="type">InfSessionProxy</span></a> *proxy</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_params</code></em>,
<em class="parameter"><code>const <span class="type">GParameter</span> *params</code></em>,
<em class="parameter"><code><a class="link" href="InfRequest.html#InfRequestFunc" title="InfRequestFunc ()"><span class="type">InfRequestFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Requests a user join for a user with the given properties (which must not
include <a class="link" href="InfUser.html#InfUser--id" title="The “id” property"><span class="type">“id”</span></a> or <a class="link" href="InfUser.html#InfUser--flags" title="The “flags” property"><span class="type">“flags”</span></a> since these are chosen by the session
proxy). The <a class="link" href="InfUser.html#InfUser--status" title="The “status” property"><span class="type">“status”</span></a> property is optional and defaults to
<a class="link" href="InfUser.html#INF-USER-ACTIVE:CAPS"><code class="literal">INF_USER_ACTIVE</code></a> if not given. It must not be <a class="link" href="InfUser.html#INF-USER-UNAVAILABLE:CAPS"><code class="literal">INF_USER_UNAVAILABLE</code></a>.</p>
<p>The request might either finish during the call to this function, in which
case <em class="parameter"><code>func</code></em>
will be called and <code class="literal">NULL</code> being returned. If the request does not
finish within the function call, a <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> object is returned,
where <em class="parameter"><code>func</code></em>
has been installed for the <a class="link" href="InfRequest.html#InfRequest-finished" title="The “finished” signal"><span class="type">“finished”</span></a> signal,
so that it is called as soon as the request finishes.</p>
<div class="refsect3">
<a name="id-1.3.5.12.2.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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfSessionProxy.html" title="InfSessionProxy"><span class="type">InfSessionProxy</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_params</p></td>
<td class="parameter_description"><p>Number of parameters.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>params</p></td>
<td class="parameter_description"><p>Construction properties for the InfUser (or derived) object.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>Function to be called on completion of the user join, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>Additional data to be passed to <em class="parameter"><code>func</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.5.12.2.7"></a><h4>Returns</h4>
<p> A <a class="link" href="InfRequest.html" title="InfRequest"><span class="type">InfRequest</span></a> object that may be used to get notified
when the request finishes, or <code class="literal">NULL</code>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfSessionProxy.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfSessionProxy-struct"></a><h3>InfSessionProxy</h3>
<pre class="programlisting">typedef struct _InfSessionProxy InfSessionProxy;</pre>
<p><a class="link" href="InfSessionProxy.html" title="InfSessionProxy"><span class="type">InfSessionProxy</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="InfSessionProxyIface"></a><h3>struct InfSessionProxyIface</h3>
<pre class="programlisting">struct InfSessionProxyIface {
InfRequest* (*join_user)(InfSessionProxy* proxy,
guint n_params,
const GParameter* params,
InfRequestFunc func,
gpointer user_data);
};
</pre>
<p>Virtual functions for the <a class="link" href="InfSessionProxy.html" title="InfSessionProxy"><span class="type">InfSessionProxy</span></a> interface.</p>
<div class="refsect3">
<a name="id-1.3.5.13.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="InfSessionProxyIface.join-user"></a>join_user</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to join a user into the proxy's session.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfSessionProxy.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfSessionProxy--session"></a><h3>The <code class="literal">“session”</code> property</h3>
<pre class="programlisting"> “session” <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> *</pre>
<p>The underlying session object.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
</div>
<div class="refsect1">
<a name="InfSessionProxy.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>, <a class="link" href="InfBrowser.html" title="InfBrowser"><span class="type">InfBrowser</span></a>, <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a>, <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|