From 06828fcab9b80b89867ce269a45dbc62aec08c38 Mon Sep 17 00:00:00 2001 From: Gian Mario Tagliaretti Date: Sun, 8 Mar 2009 22:11:30 +0000 Subject: Add few gio classes. 2009-03-08 Gian Mario Tagliaretti * docs/Makefile.am: * docs/reference/pygio-classes.xml: * docs/reference/pygobject-ref.xml: * docs/reference/pygio-applaunchcontext.xml: * docs/reference/pygio-cancellable.xml: Add few gio classes. svn path=/trunk/; revision=1023 --- docs/reference/pygio-cancellable.xml | 159 +++++++++++++++++++++++++++++++++++ 1 file changed, 159 insertions(+) create mode 100644 docs/reference/pygio-cancellable.xml (limited to 'docs/reference/pygio-cancellable.xml') diff --git a/docs/reference/pygio-cancellable.xml b/docs/reference/pygio-cancellable.xml new file mode 100644 index 0000000..d36421c --- /dev/null +++ b/docs/reference/pygio-cancellable.xml @@ -0,0 +1,159 @@ + + + + + + gio.Cancellable + Thread-safe Operation Cancellation Stack. + + + + Synopsis + + + gio.Cancellable + gobject.GObject + + + gio.Cancellable + + + + + cancel + + + + get_fd + + + + is_cancelled + + + + pop_current + + + + push_current + + + + reset + + + + set_error_if_cancelled + + + + + + + + Ancestry + ++-- gobject.GObject + +-- gio.Cancellable + + + + + + Description + + + The gio.Cancellable + is a thread-safe operation cancellation stack used throughout GIO to allow for + cancellation of synchronous and asynchronous operations. + + + + + Constructor + + + gio.Cancellable + + + + + Returns : + a new + gio.Cancellable. + + + + + + Creates a new gio.Cancellable object. + + + Applications that want to start one or more operations that should be cancellable should create a + gio.Cancellable + and pass it to the operations. + + + One gio.Cancellable + can be used in multiple consecutive operations, but not in multiple concurrent operations. + + + + + + Methods + + + gio.Cancellable.cancel + + + cancel + + + + + + + + The cancel() method will set cancellable to cancelled, + and will emit the "cancelled" signal. (However, see the warning about race conditions + in the documentation for that signal if you are planning to connect to it.) + + + This function is thread-safe. In other words, you can safely call it from a thread + other than the one running the operation that was passed the cancellable. + + + The convention within gio is that cancelling an asynchronous operation causes it + to complete asynchronously. That is, if you cancel the operation from the same thread + in which it is running, then the operation's GAsyncReadyCallback will not be invoked + until the application returns to the main loop. + + + + + gio.Cancellable.get_fd + + + get_fd + + + + + + Returns : + A valid file descriptor. -1 if the file descriptor + is not supported, or on errors. + + + + + The get_fd() method gets the file descriptor + for a cancellable job. This can be used to implement cancellable operations + on Unix systems. The returned fd will turn readable when cancellable is cancelled. + + + + -- cgit