From ebddee47fb7f3e06f9e0a7a14b9532d5cf8a3881 Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Sun, 21 Jun 2009 18:35:56 +0200 Subject: Add docs for gio.Unix[In|Out]putStream classes --- docs/reference/pygio-classes.xml | 2 + docs/reference/pygio-unixinputstream.xml | 202 ++++++++++++++++++++++++++++++ docs/reference/pygio-unixoutputstream.xml | 202 ++++++++++++++++++++++++++++++ 3 files changed, 406 insertions(+) create mode 100644 docs/reference/pygio-unixinputstream.xml create mode 100644 docs/reference/pygio-unixoutputstream.xml (limited to 'docs/reference') 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 @@ + + 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 @@ + + + + + + gio.UnixInputStream + Streaming input operations for UNIX file descriptors. + + + + Synopsis + + + gio.UnixInputStream + gio.InputStream + + + gio.UnixInputStream + fd + close_fd + + + + get_close_fd + + + + get_fd + + + + set_close_fd + close_fd + + + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.InputStream + +-- gio.UnixInputStream + + + + + + gio.UnixInputStream Properties + +
+ + + + + + + + "close-fd" + Read - Write + Whether to close the file descriptor when the stream is closed. + Default value: True. + + + "fd" + Read - Write - Construct only + The file descriptor that the stream reads from. Default value: -1. + + + + +
+ + + + + Description + + + gio.UnixInputStream + implements gio.InputStream + for reading from a UNIX file descriptor, including asynchronous operations. + The file descriptor must be selectable, so it doesn't work with opened files. + + + Note that gio.UnixInputStream + belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file + when using it. + + + + + Constructor + + + gio.UnixInputStream + fd + close_fd + + + + fd : + a UNIX file descriptor. + + + + close_fd : + True + to close the file descriptor when done + + + + Returns : + a new + gio.UnixInputStream + + + + + + Creates a new gio.UnixInputStream + from the given fd. + + + If close_fd is True, the file descriptor will be closed when the stream is closed. + + + + + + Methods + + + gio.UnixInputStream.get_close_fd + + + get_close_fd + + + + + + Returns : + True if the file descriptor is closed when done. + + + + + + The get_close_fd() method returns whether the file + descriptor of stream will be closed when the stream is closed. + + + + + gio.UnixInputStream.get_fd + + + get_fd + + + + + + Returns : + The file descriptor of stream. + + + + + + The get_fd() method return the UNIX file descriptor + that the stream reads from. + + + + + gio.UnixInputStream.set_close_fd + + + set_close_fd + close_fd + + + + + close_fd : + True to close the file descriptor when done . + + + + + + The set_close_fd() method sets whether the file descriptor + of stream shall be closed when the stream is closed. + + + + 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 @@ + + + + + + gio.UnixOutputStream + Streaming output operations for UNIX file descriptors. + + + + Synopsis + + + gio.UnixOutputStream + gio.OutputStream + + + gio.UnixOutputStream + fd + close_fd + + + + get_close_fd + + + + get_fd + + + + set_close_fd + close_fd + + + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.OutputStream + +-- gio.UnixOutputStream + + + + + + gio.UnixOutputStream Properties + +
+ + + + + + + + "close-fd" + Read - Write + Whether to close the file descriptor when the stream is closed. + Default value: True. + + + "fd" + Read - Write - Construct only + The file descriptor that the stream writes to. Default value: -1. + + + + +
+ + + + + Description + + + gio.UnixOutputStream + implements gio.OutputStream + for writing to a UNIX file descriptor, including asynchronous operations. + The file descriptor must be selectable, so it doesn't work with opened files. + + + Note that gio.UnixOutputStream + belongs to the UNIX-specific GIO interfaces, thus you have to use the gio-unix-2.0.pc pkg-config file + when using it. + + + + + Constructor + + + gio.UnixOutputStream + fd + close_fd + + + + fd : + a UNIX file descriptor. + + + + close_fd : + True + to close the file descriptor when done + + + + Returns : + a new + gio.UnixOutputStream + + + + + + Creates a new gio.UnixOutputStream + from the given fd. + + + If close_fd is True, the file descriptor will be closed when the stream is closed. + + + + + + Methods + + + gio.UnixOutputStream.get_close_fd + + + get_close_fd + + + + + + Returns : + True if the file descriptor is closed when done. + + + + + + The get_close_fd() method returns whether the file + descriptor of stream will be closed when the stream is closed. + + + + + gio.UnixOutputStream.get_fd + + + get_fd + + + + + + Returns : + The file descriptor of stream. + + + + + + The get_fd() method return the UNIX file descriptor + that the stream reads from. + + + + + gio.UnixOutputStream.set_close_fd + + + set_close_fd + close_fd + + + + + close_fd : + True to close the file descriptor when done . + + + + + + The set_close_fd() method sets whether the file descriptor + of stream shall be closed when the stream is closed. + + + + -- cgit