gnomevfs-0.11.0: Binding to the GNOME Virtual File System library.

Portabilityportable (depends on GHC)
Stabilityalpha
Maintainergtk2hs-devel@lists.sourceforge.net

System.Gnome.VFS.Cancellation

Contents

Description

 

Synopsis

Types

data Cancellation Source

An object that can be used for signalling cancellation of an operation.

Cancellation creation

cancellationNewSource

Arguments

:: IO Cancellation

a new Cancellation object

Create a new Cancellation object for reporting cancellation to a gnome-vfs module.

Cancellation notification

cancellationCancelSource

Arguments

:: Cancellation

cancellation - the object to request cancellation through

-> IO () 

Send a cancellation request through a Cancellation object.

cancellationCheckSource

Arguments

:: Cancellation

cancellation - the object to check for cancellation

-> IO Bool

True if cancellation has been requested, False otherwise

Check for pending cancellation.

cancellationAckSource

Arguments

:: Cancellation

cancellation - the object to achnowledge cancellation

-> IO () 

Acknowledge a cancellation. This should be called if cancellationCheck returns True.

Other Operations

cancellationGetFDSource

Arguments

:: Cancellation

cancellation - the object to get a file descriptor for

-> IO Fd

the file descriptor

Get a file descriptor-based notificator for cancellation. When cancellation receives a cancellation request, a character will be made available on the returned file descriptor for input.

This is very useful for detecting cancellation during I/O operations: you can use the select() call to check for available input/output on the file you are reading/writing, and on the notificator's file descriptor at the same time. If a data is available on the notificator's file descriptor, you know you have to cancel the read/write operation.