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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
|
<!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: InfcSessionProxy</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="ch04.html" title="Libinfinity client side API">
<link rel="prev" href="libinfinity-0.6-InfcNotePlugin.html" title="InfcNotePlugin">
<link rel="next" href="InfcRequest.html" title="InfcRequest">
<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="#InfcSessionProxy.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfcSessionProxy.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#InfcSessionProxy.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfcSessionProxy.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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libinfinity-0.6-InfcNotePlugin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfcRequest.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfcSessionProxy"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfcSessionProxy.top_of_page"></a>InfcSessionProxy</span></h2>
<p>InfcSessionProxy — Client-side session management</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfcSessionProxy.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="InfcSessionProxy.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">void</span>
</td>
<td class="function_name">
<a class="link" href="InfcSessionProxy.html#infc-session-proxy-set-connection" title="infc_session_proxy_set_connection ()">infc_session_proxy_set_connection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcSessionProxy.html#infc-session-proxy-get-connection" title="infc_session_proxy_get_connection ()">infc_session_proxy_get_connection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="returnvalue">InfCommunicationJoinedGroup</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfcSessionProxy.html#infc-session-proxy-get-subscription-group" title="infc_session_proxy_get_subscription_group ()">infc_session_proxy_get_subscription_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.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="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *</td>
<td class="property_name"><a class="link" href="InfcSessionProxy.html#InfcSessionProxy--connection" title="The “connection” property">connection</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *</td>
<td class="property_name"><a class="link" href="InfcSessionProxy.html#InfcSessionProxy--subscription-group" title="The “subscription-group” property">subscription-group</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.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">struct</td>
<td class="function_name"><a class="link" href="InfcSessionProxy.html#InfcSessionProxy-struct" title="struct InfcSessionProxy">InfcSessionProxy</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfcSessionProxy.html#InfcSessionProxyClass" title="struct InfcSessionProxyClass">InfcSessionProxyClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> InfcSessionProxy
</pre>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
InfcSessionProxy implements
<a class="link" href="InfCommunicationObject.html" title="InfCommunicationObject">InfCommunicationObject</a> and <a class="link" href="InfSessionProxy.html" title="InfSessionProxy">InfSessionProxy</a>.</p>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/client/infc-session-proxy.h>
</pre>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.description"></a><h2>Description</h2>
<p><a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> is a manager for <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> that is specific for the
client side. The <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> manages exactly one <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a>. It is
usually created by <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a> when a subscription to a node is made.</p>
<p><a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> allows to perform client-specific operations for the
session it manages, such as joining a user. In addition it handles requests
made by its counterpart, <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>, for the server side, such as
remote user joins and forced session closure.</p>
<p><a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> implements the <a class="link" href="InfSessionProxy.html" title="InfSessionProxy"><span class="type">InfSessionProxy</span></a> interface, which can be
used to access the underlying <a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a> or to join a user.</p>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="infc-session-proxy-set-connection"></a><h3>infc_session_proxy_set_connection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infc_session_proxy_set_connection (<em class="parameter"><code><a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> *proxy</code></em>,
<em class="parameter"><code><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *group</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> seq_id</code></em>);</pre>
<p>Sets the subscription connection for the given session. The subscription
connection is the connection through which session requests are transmitted
during subscription.</p>
<p>The subscription connection might be set even if the session is in
SYNCHRONIZING state in which case the session is immediately subscribed
after synchronization. Note that no attempt is made to tell the other end
about the subscription.</p>
<p><em class="parameter"><code>seq_id</code></em>
should be a sequence identifier obtained from the server side. It
must be the same number that is used on the corresponding <a class="link" href="InfdSessionProxy.html" title="InfdSessionProxy"><span class="type">InfdSessionProxy</span></a>
on the remote side, see <a class="link" href="InfdSessionProxy.html#infd-session-proxy-subscribe-to" title="infd_session_proxy_subscribe_to ()"><code class="function">infd_session_proxy_subscribe_to()</code></a>. Normally
<a class="link" href="InfdDirectory.html" title="InfdDirectory"><span class="type">InfdDirectory</span></a> or <a class="link" href="InfcBrowser.html" title="InfcBrowser"><span class="type">InfcBrowser</span></a>, respectively, take care of passing the
correct sequence identifier.</p>
<p>When the subscription connection is being closed or replaced (by a
subsequent call to this function), all pending requests are dropped and
all users are set to be unavailable, but the session will not be closed,
so it may be reused by setting another subscription connection. However,
the session might not be synchronized again, but it is fully okay to close
the session by hand (using inf_session_close) and create a new session
that is synchronized.</p>
<div class="refsect3">
<a name="id-1.5.4.11.2.8"></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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> of subscribed connections. Ignored
if <em class="parameter"><code>connection</code></em>
is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>connection</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>seq_id</p></td>
<td class="parameter_description"><p>A sequence identifier for <em class="parameter"><code>connection</code></em>
. Ignored if <em class="parameter"><code>connection</code></em>
is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-session-proxy-get-connection"></a><h3>infc_session_proxy_get_connection ()</h3>
<pre class="programlisting"><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> *
infc_session_proxy_get_connection (<em class="parameter"><code><a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> *proxy</code></em>);</pre>
<p>Returns the connection that is used to transmit requests to the publisher
of the session, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the session is not subscribed.</p>
<div class="refsect3">
<a name="id-1.5.4.11.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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.11.3.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infc-session-proxy-get-subscription-group"></a><h3>infc_session_proxy_get_subscription_group ()</h3>
<pre class="programlisting"><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="returnvalue">InfCommunicationJoinedGroup</span></a> *
infc_session_proxy_get_subscription_group
(<em class="parameter"><code><a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> *proxy</code></em>);</pre>
<p>Returns the group with all subscribed connections to the session, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
if the session is not subscribed.</p>
<div class="refsect3">
<a name="id-1.5.4.11.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>proxy</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.4.11.4.6"></a><h4>Returns</h4>
<p> A <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfcSessionProxy-struct"></a><h3>struct InfcSessionProxy</h3>
<pre class="programlisting">struct InfcSessionProxy;</pre>
<p><a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</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="InfcSessionProxyClass"></a><h3>struct InfcSessionProxyClass</h3>
<pre class="programlisting">struct InfcSessionProxyClass {
GError* (*translate_error)(InfcSessionProxy* session,
GQuark domain,
guint code);
};
</pre>
<p>This structure contains virtual functions of the <a class="link" href="InfcSessionProxy.html" title="InfcSessionProxy"><span class="type">InfcSessionProxy</span></a> class.</p>
<div class="refsect3">
<a name="id-1.5.4.12.3.5"></a><h4>Members</h4>
<div class="informaltable"><table 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="InfcSessionProxyClass.translate-error"></a>translate_error</code></em> ()</p></td>
<td class="struct_member_description"><p>Virtual function to transform an error domain and code
into a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> object. If the domain and code are known, this allows to
show a localized error message to the user, independent from the language
the server uses in the error message that went over the wire.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfcSessionProxy--connection"></a><h3>The <code class="literal">“connection”</code> property</h3>
<pre class="programlisting"> “connection” <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *</pre>
<p>The connection with which the session communicates with the server.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="InfcSessionProxy--subscription-group"></a><h3>The <code class="literal">“subscription-group”</code> property</h3>
<pre class="programlisting"> “subscription-group” <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *</pre>
<p>The communication group of subscribed connections.</p>
<p>Flags: Read</p>
</div>
</div>
<div class="refsect1">
<a name="InfcSessionProxy.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfSession.html" title="InfSession"><span class="type">InfSession</span></a></p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|