Cancellable

---

Object Hierarchy:

Description:

Content:

Static methods:

• public static weak Cancellable? get_current ()
  Gets the top cancellable from the stack.

Creation methods:

• public Cancellable ()
  Creates a new Cancellable object.

Methods:

• public void cancel ()
  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.)
• public ulong connect (owned Func<Cancellable> callback)
  Convenience function to connect to the cancelled signal. Also handles the race condition that may happen if the cancellable is cancelled right before connecting.
• public void disconnect (ulong handler_id)
  Disconnects a handler from a cancellable instance similar to disconnect. Additionally, in the event that a signal handler is currently running, this call will block until the handler has finished. Calling this function from a cancelled signal handler will therefore result in a deadlock.
• public int get_fd ()
  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.
• public bool is_cancelled ()
  Checks if a cancellable job has been cancelled.
• public bool make_pollfd (PollFD pollfd)
  Creates a PollFD corresponding to cancellable; this can be passed to g_poll and used to poll for cancellation. This is useful both for unix systems without a native poll and for portability to windows.
• public void pop_current ()
  Pops cancellable off the cancellable stack (verifying that cancellable is on the top of the stack).
• public void push_current ()
  Pushes cancellable onto the cancellable stack. The current cancellable can then be received using get_current.
• public void release_fd ()
  Releases a resources previously allocated by get_fd or make_pollfd.
• public void reset ()
  Resets cancellable to its uncancelled state.
• public bool set_error_if_cancelled () throws IOError
  If the cancellable is cancelled, sets the error to notify that the operation was cancelled.
• public weak TimeoutSource source_new ()
  Creates a source that triggers if cancellable is cancelled and calls its callback of type CancellableSourceFunc. This is primarily useful for attaching to another (non-cancellable) source with g_source_add_child_source to add cancellability to it.

Signals:

• public virtual void cancelled ()
  Emitted when the operation has been cancelled.