luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-10 04:45:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Introduce new GPollableReturn enum

Browse Source 
This allows returning WOULD_BLOCK without allocating a GError, and
should later be used for various functions of GPollableOutputStream,
GPollableInputStream and anything else that can potentially block.
This commit is contained in:
Sebastian Dröge 2019-01-04 12:48:26 +02:00
parent 72329ea303
commit 042b8dc40d
2 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/reference/gio/gio-sections.txt
View File

@ -3659,6 +3659,7 @@ g_pollable_output_stream_get_type
<SECTION> <SECTION>
<FILE>gpollableutils</FILE> <FILE>gpollableutils</FILE>
GPollableReturn
GPollableSourceFunc GPollableSourceFunc
g_pollable_source_new g_pollable_source_new
g_pollable_source_new_full g_pollable_source_new_full

27
gio/gioenums.h
View File

@ -512,6 +512,9 @@ typedef enum {
* ]| * ]|
* but should instead treat all unrecognized error codes the same as * but should instead treat all unrecognized error codes the same as
* #G_IO_ERROR_FAILED. * #G_IO_ERROR_FAILED.
*
* See also #GPollableReturn for a cheaper way of returning
* %G_IO_ERROR_WOULD_BLOCK to callers without allocating a #GError.
**/ **/
typedef enum { typedef enum {
G_IO_ERROR_FAILED, G_IO_ERROR_FAILED,
@ -1922,6 +1925,30 @@ typedef enum {
G_NETWORK_CONNECTIVITY_FULL = 4 G_NETWORK_CONNECTIVITY_FULL = 4
} GNetworkConnectivity; } GNetworkConnectivity;
/**
* GPollableReturn:
* @G_POLLABLE_RETURN_FAILED: Generic error condition for when an operation fails.
* @G_POLLABLE_RETURN_OK: The operation was successfully finished.
* @G_POLLABLE_RETURN_WOULD_BLOCK: The operation would block.
*
* Return value for various IO operations that signal errors via the
* return value and not necessarily via a #GError.
*
* This enum exists to be able to return errors to callers without having to
* allocate a #GError. Allocating #GErrors can be quite expensive for
* regularly happening errors like %G_IO_ERROR_WOULD_BLOCK.
*
* In case of %G_POLLABLE_RETURN_FAILED a #GError should be set for the
* operation to give details about the error that happened.
*
* Since: 2.60
*/
typedef enum {
G_POLLABLE_RETURN_FAILED = 0,
G_POLLABLE_RETURN_OK = 1,
G_POLLABLE_RETURN_WOULD_BLOCK = -G_IO_ERROR_WOULD_BLOCK
} GPollableReturn;
G_END_DECLS G_END_DECLS
#endif /* __GIO_ENUMS_H__ */ #endif /* __GIO_ENUMS_H__ */