[pygobject] Add docs for gio.Unix[In|Out]putStream classes
- From: Gian Mario Tagliaretti <gianmt src gnome org>
- To: svn-commits-list gnome org
- Subject: [pygobject] Add docs for gio.Unix[In|Out]putStream classes
- Date: Sun, 21 Jun 2009 12:37:48 -0400 (EDT)
commit ebddee47fb7f3e06f9e0a7a14b9532d5cf8a3881
Author: Gian Mario Tagliaretti <gianmt gnome org>
Date: Sun Jun 21 18:35:56 2009 +0200
Add docs for gio.Unix[In|Out]putStream classes
docs/Makefile.am | 4 +
docs/reference/pygio-classes.xml | 2 +
docs/reference/pygio-unixinputstream.xml | 202 +++++++++++++++++++++++++++++
docs/reference/pygio-unixoutputstream.xml | 202 +++++++++++++++++++++++++++++
4 files changed, 410 insertions(+), 0 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index b9adbb1..6c8dafb 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -48,6 +48,8 @@ HTML_FILES = \
html/class-gioseekable.html \
html/class-giosimpleasyncresult.html \
html/class-giothemedicon.html \
+ html/class-giounixinputstream.html \
+ html/class-giounixoutputstream.html \
html/class-giovolume.html \
html/class-giovolumemonitor.html \
html/gio-constants.html \
@@ -109,6 +111,8 @@ XML_FILES = \
reference/pygio-seekable.xml \
reference/pygio-simpleasyncresult.xml \
reference/pygio-themedicon.xml \
+ reference/pygio-unixinputstream.xml \
+ reference/pygio-unixoutputstream.xml \
reference/pygio-volume.xml \
reference/pygio-volumemonitor.xml
diff --git a/docs/reference/pygio-classes.xml b/docs/reference/pygio-classes.xml
index 57c0390..b46ca91 100644
--- a/docs/reference/pygio-classes.xml
+++ b/docs/reference/pygio-classes.xml
@@ -39,6 +39,8 @@
<xi:include href="pygio-seekable.xml"/>
<xi:include href="pygio-simpleasyncresult.xml"/>
<xi:include href="pygio-themedicon.xml"/>
+<xi:include href="pygio-unixinputstream.xml"/>
+<xi:include href="pygio-unixoutputstream.xml"/>
<xi:include href="pygio-volume.xml"/>
<xi:include href="pygio-volumemonitor.xml"/>
<xi:include href="pygio-constants.xml"/>
diff --git a/docs/reference/pygio-unixinputstream.xml b/docs/reference/pygio-unixinputstream.xml
new file mode 100644
index 0000000..904501d
--- /dev/null
+++ b/docs/reference/pygio-unixinputstream.xml
@@ -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>
diff --git a/docs/reference/pygio-unixoutputstream.xml b/docs/reference/pygio-unixoutputstream.xml
new file mode 100644
index 0000000..cebc623
--- /dev/null
+++ b/docs/reference/pygio-unixoutputstream.xml
@@ -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-giounixoutputstream">
+ <refnamediv>
+ <refname>gio.UnixOutputStream</refname>
+ <refpurpose>Streaming output operations for UNIX file descriptors.</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gio.UnixOutputStream</classname></ooclass>
+ <ooclass><classname><link linkend="class-giooutputstream">gio.OutputStream</link></classname></ooclass>
+
+ <constructorsynopsis language="python">
+ <methodname><link linkend="constructor-giounixoutputstream">gio.UnixOutputStream</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-giounixoutputstream--get-close-fd">get_close_fd</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giounixoutputstream--get-fd">get_fd</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-giounixoutputstream--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-giooutputstream">gio.OutputStream</link>
+ +-- <link linkend="class-giounixoutputstream">gio.UnixOutputStream</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1 id="properties-giounixoutputstream">
+ <title>gio.UnixOutputStream 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 writes to. Default value: -1.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </blockquote>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para>
+ <link linkend="class-giounixoutputstream"><classname>gio.UnixOutputStream</classname></link>
+ implements <link linkend="class-giooutputstream"><classname>gio.OutputStream</classname></link>
+ for writing to 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-giounixoutputstream"><classname>gio.UnixOutputStream</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-giounixoutputstream">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>gio.UnixOutputStream</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-giounixoutputstream"><classname>gio.UnixOutputStream</classname></link>
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Creates a new <link linkend="class-giounixoutputstream"><classname>gio.UnixOutputStream</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-giounixoutputstream--get-close-fd">
+ <title>gio.UnixOutputStream.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-giounixoutputstream--get-fd">
+ <title>gio.UnixOutputStream.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-giounixoutputstream--set-close-fd">
+ <title>gio.UnixOutputStream.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>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
