mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-04-16 12:28:48 +02:00
Fix a typo
...and some whitespace fixes. Pointed out by Will Thompson in bug 602417.
This commit is contained in:
parent
0542e6dbf9
commit
74af99b860
@ -1,5 +1,5 @@
|
|||||||
/* GIO - GLib Input, Output and Streaming Library
|
/* GIO - GLib Input, Output and Streaming Library
|
||||||
*
|
*
|
||||||
* Copyright (C) 2006-2007 Red Hat, Inc.
|
* Copyright (C) 2006-2007 Red Hat, Inc.
|
||||||
*
|
*
|
||||||
* This library is free software; you can redistribute it and/or
|
* This library is free software; you can redistribute it and/or
|
||||||
@ -31,35 +31,35 @@
|
|||||||
* @short_description: Asynchronous Function Results
|
* @short_description: Asynchronous Function Results
|
||||||
* @include: gio/gio.h
|
* @include: gio/gio.h
|
||||||
* @see_also: #GSimpleAsyncResult
|
* @see_also: #GSimpleAsyncResult
|
||||||
*
|
*
|
||||||
* Provides a base class for implementing asynchronous function results.
|
* Provides a base class for implementing asynchronous function results.
|
||||||
*
|
*
|
||||||
* Asynchronous operations are broken up into two separate operations
|
* Asynchronous operations are broken up into two separate operations
|
||||||
* which are chained together by a #GAsyncReadyCallback. To begin
|
* which are chained together by a #GAsyncReadyCallback. To begin
|
||||||
* an asynchronous operation, provide a #GAsyncReadyCallback to the
|
* an asynchronous operation, provide a #GAsyncReadyCallback to the
|
||||||
* asynchronous function. This callback will be triggered when the
|
* asynchronous function. This callback will be triggered when the
|
||||||
* operation has completed, and will be passed a #GAsyncResult instance
|
* operation has completed, and will be passed a #GAsyncResult instance
|
||||||
* filled with the details of the operation's success or failure, the
|
* filled with the details of the operation's success or failure, the
|
||||||
* object the asynchronous function was started for and any error codes
|
* object the asynchronous function was started for and any error codes
|
||||||
* returned. The asynchronous callback function is then expected to call
|
* returned. The asynchronous callback function is then expected to call
|
||||||
* the corresponding "_finish()" function with the object the function
|
* the corresponding "_finish()" function with the object the function
|
||||||
* was called for, and the #GAsyncResult instance, and optionally,
|
* was called for, and the #GAsyncResult instance, and optionally,
|
||||||
* an @error to grab any error conditions that may have occurred.
|
* an @error to grab any error conditions that may have occurred.
|
||||||
*
|
*
|
||||||
* The purpose of the "_finish()" function is to take the generic
|
* The purpose of the "_finish()" function is to take the generic
|
||||||
* result of type #GAsyncResult and return the specific result
|
* result of type #GAsyncResult and return the specific result
|
||||||
* that the operation in question yields (e.g. a #GFileEnumerator for
|
* that the operation in question yields (e.g. a #GFileEnumerator for
|
||||||
* a "enumerate children" operation). If the result or error status
|
* a "enumerate children" operation). If the result or error status
|
||||||
* of the operation is not needed, there is no need to call the
|
* of the operation is not needed, there is no need to call the
|
||||||
* "_finish()" function, GIO will take care of cleaning up the
|
* "_finish()" function, GIO will take care of cleaning up the
|
||||||
* result and error information after the #GAsyncReadyCallback
|
* result and error information after the #GAsyncReadyCallback
|
||||||
* returns. It is also allowed to take a reference to the #GAsyncResult and
|
* returns. It is also allowed to take a reference to the #GAsyncResult
|
||||||
* call "_finish()" later.
|
* and call "_finish()" later.
|
||||||
*
|
*
|
||||||
* Example of a typical asynchronous operation flow:
|
* Example of a typical asynchronous operation flow:
|
||||||
* |[
|
* |[
|
||||||
* void _theoretical_frobnitz_async (Theoretical *t,
|
* void _theoretical_frobnitz_async (Theoretical *t,
|
||||||
* GCancellable *c,
|
* GCancellable *c,
|
||||||
* GAsyncReadyCallback *cb,
|
* GAsyncReadyCallback *cb,
|
||||||
* gpointer u);
|
* gpointer u);
|
||||||
*
|
*
|
||||||
@ -67,9 +67,9 @@
|
|||||||
* GAsyncResult *res,
|
* GAsyncResult *res,
|
||||||
* GError **e);
|
* GError **e);
|
||||||
*
|
*
|
||||||
* static void
|
* static void
|
||||||
* frobnitz_result_func (GObject *source_object,
|
* frobnitz_result_func (GObject *source_object,
|
||||||
* GAsyncResult *res,
|
* GAsyncResult *res,
|
||||||
* gpointer user_data)
|
* gpointer user_data)
|
||||||
* {
|
* {
|
||||||
* gboolean success = FALSE;
|
* gboolean success = FALSE;
|
||||||
@ -78,7 +78,7 @@
|
|||||||
*
|
*
|
||||||
* if (success)
|
* if (success)
|
||||||
* g_printf ("Hurray!\n");
|
* g_printf ("Hurray!\n");
|
||||||
* else
|
* else
|
||||||
* g_printf ("Uh oh!\n");
|
* g_printf ("Uh oh!\n");
|
||||||
*
|
*
|
||||||
* /<!-- -->* ... *<!-- -->/
|
* /<!-- -->* ... *<!-- -->/
|
||||||
@ -89,9 +89,9 @@
|
|||||||
* {
|
* {
|
||||||
* /<!-- -->* ... *<!-- -->/
|
* /<!-- -->* ... *<!-- -->/
|
||||||
*
|
*
|
||||||
* _theoretical_frobnitz_async (theoretical_data,
|
* _theoretical_frobnitz_async (theoretical_data,
|
||||||
* NULL,
|
* NULL,
|
||||||
* frobnitz_result_func,
|
* frobnitz_result_func,
|
||||||
* NULL);
|
* NULL);
|
||||||
*
|
*
|
||||||
* /<!-- -->* ... *<!-- -->/
|
* /<!-- -->* ... *<!-- -->/
|
||||||
@ -101,11 +101,12 @@
|
|||||||
* The callback for an asynchronous operation is called only once, and is
|
* The callback for an asynchronous operation is called only once, and is
|
||||||
* always called, even in the case of a cancelled operation. On cancellation
|
* always called, even in the case of a cancelled operation. On cancellation
|
||||||
* the result is a %G_IO_ERROR_CANCELLED error.
|
* the result is a %G_IO_ERROR_CANCELLED error.
|
||||||
*
|
*
|
||||||
* Some ascynchronous operations are implemented using synchronous calls. These
|
* Some asynchronous operations are implemented using synchronous calls.
|
||||||
* are run in a separate thread, if #GThread has been initialized, but otherwise they
|
* These are run in a separate thread, if #GThread has been initialized, but
|
||||||
* are sent to the Main Event Loop and processed in an idle function. So, if you
|
* otherwise they are sent to the Main Event Loop and processed in an idle
|
||||||
* truly need asynchronous operations, make sure to initialize #GThread.
|
* function. So, if you truly need asynchronous operations, make sure to
|
||||||
|
* initialize #GThread.
|
||||||
**/
|
**/
|
||||||
|
|
||||||
typedef GAsyncResultIface GAsyncResultInterface;
|
typedef GAsyncResultIface GAsyncResultInterface;
|
||||||
@ -119,10 +120,10 @@ g_async_result_default_init (GAsyncResultInterface *iface)
|
|||||||
/**
|
/**
|
||||||
* g_async_result_get_user_data:
|
* g_async_result_get_user_data:
|
||||||
* @res: a #GAsyncResult.
|
* @res: a #GAsyncResult.
|
||||||
*
|
*
|
||||||
* Gets the user data from a #GAsyncResult.
|
* Gets the user data from a #GAsyncResult.
|
||||||
*
|
*
|
||||||
* Returns: the user data for @res.
|
* Returns: the user data for @res.
|
||||||
**/
|
**/
|
||||||
gpointer
|
gpointer
|
||||||
g_async_result_get_user_data (GAsyncResult *res)
|
g_async_result_get_user_data (GAsyncResult *res)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user