libjsonrpc-glib-doc 3.28.0-1 / usr / share / gtk-doc / html / jsonrpc-glib / JsonrpcOutputStream.html

This file is indexed.

/usr/share/gtk-doc/html/jsonrpc-glib/JsonrpcOutputStream.html is in libjsonrpc-glib-doc 3.28.0-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
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
336
337
338
339
340
341
342
343
344
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>JsonrpcOutputStream: Jsonrpc-GLib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Jsonrpc-GLib Reference Manual">
<link rel="up" href="ch01.html" title="Jsonrpc-GLib API Reference">
<link rel="prev" href="JsonrpcInputStream.html" title="JsonrpcInputStream">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.27 (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="#JsonrpcOutputStream.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#JsonrpcOutputStream.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#JsonrpcOutputStream.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#JsonrpcOutputStream.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="JsonrpcInputStream.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="JsonrpcOutputStream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="JsonrpcOutputStream.top_of_page"></a>JsonrpcOutputStream</span></h2>
<p>JsonrpcOutputStream — A JSON-RPC output stream</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="JsonrpcOutputStream.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="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="returnvalue">JsonrpcOutputStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="JsonrpcOutputStream.html#jsonrpc-output-stream-new" title="jsonrpc_output_stream_new ()">jsonrpc_output_stream_new</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="JsonrpcOutputStream.html#jsonrpc-output-stream-get-use-gvariant" title="jsonrpc_output_stream_get_use_gvariant ()">jsonrpc_output_stream_get_use_gvariant</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="JsonrpcOutputStream.html#jsonrpc-output-stream-set-use-gvariant" title="jsonrpc_output_stream_set_use_gvariant ()">jsonrpc_output_stream_set_use_gvariant</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="JsonrpcOutputStream.html#jsonrpc-output-stream-write-message" title="jsonrpc_output_stream_write_message ()">jsonrpc_output_stream_write_message</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="JsonrpcOutputStream.html#jsonrpc-output-stream-write-message-async" title="jsonrpc_output_stream_write_message_async ()">jsonrpc_output_stream_write_message_async</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="JsonrpcOutputStream.html#jsonrpc-output-stream-write-message-finish" title="jsonrpc_output_stream_write_message_finish ()">jsonrpc_output_stream_write_message_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="JsonrpcOutputStream.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"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="JsonrpcOutputStream.html#JsonrpcOutputStream--use-gvariant" title="The “use-gvariant” property">use-gvariant</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="JsonrpcOutputStream.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="JsonrpcOutputStream.html#JSONRPC-TYPE-OUTPUT-STREAM:CAPS" title="JSONRPC_TYPE_OUTPUT_STREAM">JSONRPC_TYPE_OUTPUT_STREAM</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="JsonrpcOutputStream.html#JsonrpcOutputStreamClass" title="struct JsonrpcOutputStreamClass">JsonrpcOutputStreamClass</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="JsonrpcOutputStream.html#JsonrpcOutputStream-struct" title="JsonrpcOutputStream">JsonrpcOutputStream</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="JsonrpcOutputStream.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> GOutputStream
        <span class="lineart">╰──</span> GFilterOutputStream
            <span class="lineart">╰──</span> GDataOutputStream
                <span class="lineart">╰──</span> JsonrpcOutputStream
</pre>
</div>
<div class="refsect1">
<a name="JsonrpcOutputStream.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
JsonrpcOutputStream implements
 GSeekable.</p>
</div>
<div class="refsect1">
<a name="JsonrpcOutputStream.description"></a><h2>Description</h2>
<p>The <a class="link" href="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="type">JsonrpcOutputStream</span></a> is resonsible for serializing messages onto
the underlying stream.</p>
<p>Optionally, if <a class="link" href="JsonrpcOutputStream.html#jsonrpc-output-stream-set-use-gvariant" title="jsonrpc_output_stream_set_use_gvariant ()"><code class="function">jsonrpc_output_stream_set_use_gvariant()</code></a> has been called,
the messages will be encoded directly in the <span class="type">GVariant</span> format instead of
JSON along with setting a "Content-Type" header to "application/gvariant".
This is useful for situations where you control both sides of the RPC server
using jsonrpc-glib as you can reduce the overhead of parsing JSON nodes due
to <span class="type">GVariant</span> not requiring parsing or allocation overhead to the same degree
as JSON.</p>
<p>For example, if you need a large message, which is encoded in JSON, you need
to decode the entire message up front which avoids performing lazy operations.
When using GVariant encoding, you have a single allocation created for the
<span class="type">GVariant</span> which means you reduce the memory pressure caused by lots of small
allocations.</p>
</div>
<div class="refsect1">
<a name="JsonrpcOutputStream.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="jsonrpc-output-stream-new"></a><h3>jsonrpc_output_stream_new ()</h3>
<pre class="programlisting"><a class="link" href="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="returnvalue">JsonrpcOutputStream</span></a> *
jsonrpc_output_stream_new (<em class="parameter"><code><span class="type">GOutputStream</span> *base_stream</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="jsonrpc-output-stream-get-use-gvariant"></a><h3>jsonrpc_output_stream_get_use_gvariant ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
jsonrpc_output_stream_get_use_gvariant
                               (<em class="parameter"><code><a class="link" href="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="type">JsonrpcOutputStream</span></a> *self</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="jsonrpc-output-stream-set-use-gvariant"></a><h3>jsonrpc_output_stream_set_use_gvariant ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
jsonrpc_output_stream_set_use_gvariant
                               (<em class="parameter"><code><a class="link" href="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="type">JsonrpcOutputStream</span></a> *self</code></em>,
                                <em class="parameter"><code><span class="type">gboolean</span> use_gvariant</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="jsonrpc-output-stream-write-message"></a><h3>jsonrpc_output_stream_write_message ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
jsonrpc_output_stream_write_message (<em class="parameter"><code><a class="link" href="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="type">JsonrpcOutputStream</span></a> *self</code></em>,
                                     <em class="parameter"><code><span class="type">GVariant</span> *message</code></em>,
                                     <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                     <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Synchronously sends a message to the peer.</p>
<p>This operation will complete once the message has been buffered. There
is no guarantee the peer received it.</p>
<div class="refsect3">
<a name="jsonrpc-output-stream-write-message.parameters"></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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="type">JsonrpcOutputStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>a <span class="type">GVariant</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <span class="type">GCancellable</span> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 3.26</p>
</div>
<hr>
<div class="refsect2">
<a name="jsonrpc-output-stream-write-message-async"></a><h3>jsonrpc_output_stream_write_message_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
jsonrpc_output_stream_write_message_async
                               (<em class="parameter"><code><a class="link" href="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="type">JsonrpcOutputStream</span></a> *self</code></em>,
                                <em class="parameter"><code><span class="type">GVariant</span> *message</code></em>,
                                <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
                                <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
                                <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>Asynchronously sends a message to the peer.</p>
<p>This asynchronous operation will complete once the message has
been buffered, and there is no guarantee the peer received it.</p>
<div class="refsect3">
<a name="jsonrpc-output-stream-write-message-async.parameters"></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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="type">JsonrpcOutputStream</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>message</p></td>
<td class="parameter_description"><p>a <span class="type">GVariant</span>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>a <span class="type">GCancellable</span> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncReadyCallback</span> or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>closure data for <em class="parameter"><code>callback</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 3.26</p>
</div>
<hr>
<div class="refsect2">
<a name="jsonrpc-output-stream-write-message-finish"></a><h3>jsonrpc_output_stream_write_message_finish ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
jsonrpc_output_stream_write_message_finish
                               (<em class="parameter"><code><a class="link" href="JsonrpcOutputStream.html" title="JsonrpcOutputStream"><span class="type">JsonrpcOutputStream</span></a> *self</code></em>,
                                <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
</div>
</div>
<div class="refsect1">
<a name="JsonrpcOutputStream.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="JSONRPC-TYPE-OUTPUT-STREAM:CAPS"></a><h3>JSONRPC_TYPE_OUTPUT_STREAM</h3>
<pre class="programlisting">#define JSONRPC_TYPE_OUTPUT_STREAM (jsonrpc_output_stream_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="JsonrpcOutputStreamClass"></a><h3>struct JsonrpcOutputStreamClass</h3>
<pre class="programlisting">struct JsonrpcOutputStreamClass {
  GDataOutputStreamClass parent_class;

  gpointer _reserved1;
  gpointer _reserved2;
  gpointer _reserved3;
  gpointer _reserved4;
  gpointer _reserved5;
  gpointer _reserved6;
  gpointer _reserved7;
  gpointer _reserved8;
  gpointer _reserved9;
  gpointer _reserved10;
  gpointer _reserved11;
  gpointer _reserved12;
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="JsonrpcOutputStream-struct"></a><h3>JsonrpcOutputStream</h3>
<pre class="programlisting">typedef struct _JsonrpcOutputStream JsonrpcOutputStream;</pre>
</div>
</div>
<div class="refsect1">
<a name="JsonrpcOutputStream.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="JsonrpcOutputStream--use-gvariant"></a><h3>The <code class="literal">“use-gvariant”</code> property</h3>
<pre class="programlisting">  “use-gvariant”             <span class="type">gboolean</span></pre>
<p>If GVariant encoding should be used.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.