blob: 5ef4cde5fca323d873bb27c66c8165cd627e20d1 (
plain)
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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-giounixinputstream">
<refnamediv>
<refname>gio.unix.InputStream</refname>
<refpurpose>Streaming input operations for UNIX file descriptors.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gio.unix.InputStream</classname></ooclass>
<ooclass><classname><link linkend="class-gioinputstream">gio.InputStream</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-giounixinputstream">gio.unix.InputStream</link></methodname>
<methodparam><parameter role="keyword">fd</parameter></methodparam>
<methodparam><parameter role="keyword">close_fd</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giounixinputstream--get-close-fd">get_close_fd</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giounixinputstream--get-fd">get_fd</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-giounixinputstream--set-close-fd">set_close_fd</link></methodname>
<methodparam><parameter role="keyword">close_fd</parameter></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gioinputstream">gio.InputStream</link>
+-- <link linkend="class-giounixinputstream">gio.unix.InputStream</link>
</synopsis>
</refsect1>
<refsect1 id="properties-giounixinputstream">
<title>gio.unix.InputStream Properties</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"close-fd"</entry>
<entry>Read - Write</entry>
<entry>Whether to close the file descriptor when the stream is closed.
Default value: <literal>True</literal>.</entry>
</row>
<row valign="top">
<entry>"fd"</entry>
<entry>Read - Write - Construct only</entry>
<entry>The file descriptor that the stream reads from. Default value: -1.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1>
<title>Description</title>
<para>
<link linkend="class-giounixinputstream"><classname>gio.unix.InputStream</classname></link>
implements <link linkend="class-gioinputstream"><classname>gio.InputStream</classname></link>
for reading from a UNIX file descriptor, including asynchronous operations.
The file descriptor must be selectable, so it doesn't work with opened files.
</para>
<para>
Note that <link linkend="class-giounixinputstream"><classname>gio.unix.InputStream</classname></link>
belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file
when using it.
</para>
</refsect1>
<refsect1 id="constructor-giounixinputstream">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gio.unix.InputStream</methodname>
<methodparam><parameter role="keyword">fd</parameter></methodparam>
<methodparam><parameter role="keyword">close_fd</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter>fd</parameter> :</term>
<listitem><simpara>a UNIX file descriptor.
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter>close_fd</parameter> :</term>
<listitem><simpara><literal>True</literal>
to close the file descriptor when done
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new
<link linkend="class-giounixinputstream"><classname>gio.unix.InputStream</classname></link>
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
Creates a new <link linkend="class-giounixinputstream"><classname>gio.unix.InputStream</classname></link>
from the given fd.
</para>
<para>
If close_fd is <literal>True</literal>, the file descriptor will be closed when the stream is closed.
</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-giounixinputstream--get-close-fd">
<title>gio.unix.InputStream.get_close_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>get_close_fd</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the file descriptor is closed when done.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_close_fd</methodname>() method returns whether the file
descriptor of stream will be closed when the stream is closed.
</para>
</refsect2>
<refsect2 id="method-giounixinputstream--get-fd">
<title>gio.unix.InputStream.get_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>get_fd</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>The file descriptor of stream.
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>get_fd</methodname>() method return the UNIX file descriptor
that the stream reads from.
</para>
</refsect2>
<refsect2 id="method-giounixinputstream--set-close-fd">
<title>gio.unix.InputStream.set_close_fd</title>
<programlisting><methodsynopsis language="python">
<methodname>set_close_fd</methodname>
<methodparam><parameter role="keyword">close_fd</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">close_fd</parameter> :</term>
<listitem><simpara><literal>True</literal> to close the file descriptor when done .
</simpara></listitem>
</varlistentry>
</variablelist>
<para>
The <methodname>set_close_fd</methodname>() method sets whether the file descriptor
of stream shall be closed when the stream is closed.
</para>
</refsect2>
</refsect1>
</refentry>
|
