-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs for gio.Unix[In|Out]putStream classes
- Loading branch information
Showing
4 changed files
with
410 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,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.UnixInputStream</refname> | ||
| <refpurpose>Streaming input operations for UNIX file descriptors.</refpurpose> | ||
| </refnamediv> | ||
|
|
||
| <refsect1> | ||
| <title>Synopsis</title> | ||
|
|
||
| <classsynopsis language="python"> | ||
| <ooclass><classname>gio.UnixInputStream</classname></ooclass> | ||
| <ooclass><classname><link linkend="class-gioinputstream">gio.InputStream</link></classname></ooclass> | ||
|
|
||
| <constructorsynopsis language="python"> | ||
| <methodname><link linkend="constructor-giounixinputstream">gio.UnixInputStream</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.UnixInputStream</link> | ||
| </synopsis> | ||
|
|
||
| </refsect1> | ||
|
|
||
| <refsect1 id="properties-giounixinputstream"> | ||
| <title>gio.UnixInputStream 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.UnixInputStream</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.UnixInputStream</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.UnixInputStream</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.UnixInputStream</classname></link> | ||
| </simpara></listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
|
|
||
| <para> | ||
| Creates a new <link linkend="class-giounixinputstream"><classname>gio.UnixInputStream</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.UnixInputStream.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.UnixInputStream.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.UnixInputStream.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> |
Oops, something went wrong.