From 15799d18a1555c569c010996e7e924499e07d9af Mon Sep 17 00:00:00 2001 From: Rico Tzschichholz Date: Wed, 17 Dec 2014 12:02:24 +0100 Subject: Update glib annotations from git master --- gir/gio-2.0.c | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ gir/glib-2.0.c | 41 ++++++++++++++++++++++++-- 2 files changed, 128 insertions(+), 3 deletions(-) diff --git a/gir/gio-2.0.c b/gir/gio-2.0.c index 9123418f..25706f81 100644 --- a/gir/gio-2.0.c +++ b/gir/gio-2.0.c @@ -1909,6 +1909,17 @@ */ +/** + * GNetworkMonitor:connectivity: + * + * More detailed information about the host's network connectivity. + * See g_network_monitor_get_connectivity() and + * #GNetworkConnectivity for more details. + * + * Since: 2.44 + */ + + /** * GNetworkMonitor:network-available: * @@ -27371,6 +27382,35 @@ */ +/** + * g_network_monitor_get_connectivity: + * @monitor: the #GNetworkMonitor + * + * Gets a more detailed networking state than + * g_network_monitor_get_network_available(). + * + * If #GNetworkMonitor:network-available is %FALSE, then the + * connectivity state will be %G_NETWORK_CONNECTIVITY_LOCAL. + * + * If #GNetworkMonitor:network-available is %TRUE, then the + * connectivity state will be %G_NETWORK_CONNECTIVITY_FULL (if there + * is full Internet connectivity), %G_NETWORK_CONNECTIVITY_LIMITED (if + * the host has a default route, but appears to be unable to actually + * reach the full Internet), or %G_NETWORK_CONNECTIVITY_PORTAL (if the + * host is trapped behind a "captive portal" that requires some sort + * of login or acknowledgement before allowing full Internet access). + * + * Note that in the case of %G_NETWORK_CONNECTIVITY_LIMITED and + * %G_NETWORK_CONNECTIVITY_PORTAL, it is possible that some sites are + * reachable but others are not. In this case, applications can + * attempt to connect to remote servers, but should gracefully fall + * back to their "offline" behavior if the connection attempt fails. + * + * Returns: the network connectivity state + * Since: 2.44 + */ + + /** * g_network_monitor_get_default: * @@ -33850,6 +33890,56 @@ */ +/** + * g_socket_send_messages: + * @socket: a #GSocket + * @messages: (array length=num_messages): an array of #GOutputMessage structs + * @num_messages: the number of elements in @messages + * @flags: an int containing #GSocketMsgFlags flags + * @cancellable: (allow-none): a %GCancellable or %NULL + * @error: #GError for error reporting, or %NULL to ignore. + * + * Send multiple data messages from @socket in one go. This is the most + * complicated and fully-featured version of this call. For easier use, see + * g_socket_send(), g_socket_send_to(), and g_socket_send_message(). + * + * @messages must point to an array of #GOutputMessage structs and + * @num_messages must be the length of this array. Each #GOutputMessage + * contains an address to send the data to, and a pointer to an array of + * #GOutputVector structs to describe the buffers that the data to be sent + * for each message will be gathered from. Using multiple #GOutputVectors is + * more memory-efficient than manually copying data from multiple sources + * into a single buffer, and more network-efficient than making multiple + * calls to g_socket_send(). Sending multiple messages in one go avoids the + * overhead of making a lot of syscalls in scenarios where a lot of data + * packets need to be sent (e.g. high-bandwidth video streaming over RTP/UDP), + * or where the same data needs to be sent to multiple recipients. + * + * @flags modify how the message is sent. The commonly available arguments + * for this are available in the #GSocketMsgFlags enum, but the + * values there are the same as the system values, and the flags + * are passed in as-is, so you can pass in system-specific flags too. + * + * If the socket is in blocking mode the call will block until there is + * space for all the data in the socket queue. If there is no space available + * and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error + * will be returned if no data was written at all, otherwise the number of + * messages sent will be returned. To be notified when space is available, + * wait for the %G_IO_OUT condition. Note though that you may still receive + * %G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously + * notified of a %G_IO_OUT condition. (On Windows in particular, this is + * very common due to the way the underlying APIs work.) + * + * On error -1 is returned and @error is set accordingly. + * + * Returns: number of messages sent, or -1 on error. Note that the number of + * messages sent may be smaller than @num_messages if the socket is + * non-blocking or if @num_messages was larger than UIO_MAXIOV (1024), + * in which case the caller may re-try to send the remaining messages. + * Since: 2.44 + */ + + /** * g_socket_send_to: * @socket: a #GSocket diff --git a/gir/glib-2.0.c b/gir/glib-2.0.c index 7d8a5833..8a5c3b34 100644 --- a/gir/glib-2.0.c +++ b/gir/glib-2.0.c @@ -3471,7 +3471,7 @@ * G_GSIZE_MODIFIER: * * The platform dependent length modifier for conversion specifiers - * for scanning and printing values of type #gsize or #gssize. It + * for scanning and printing values of type #gsize. It * is a string literal. * * Since: 2.6 @@ -3488,6 +3488,17 @@ */ +/** + * G_GSSIZE_MODIFIER: + * + * The platform dependent length modifier for conversion specifiers + * for scanning and printing values of type #gssize. It + * is a string literal. + * + * Since: 2.6 + */ + + /** * G_GUINT16_FORMAT: * @@ -3678,6 +3689,16 @@ */ +/** + * G_KEY_FILE_DESKTOP_KEY_ACTIONS: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a string list + * giving the available application actions. + * + * Since: 2.38 + */ + + /** * G_KEY_FILE_DESKTOP_KEY_CATEGORIES: * @@ -3699,6 +3720,16 @@ */ +/** + * G_KEY_FILE_DESKTOP_KEY_DBUS_ACTIVATABLE: + * + * A key under #G_KEY_FILE_DESKTOP_GROUP, whose value is a boolean set to true + * if the application is D-Bus activatable. + * + * Since: 2.38 + */ + + /** * G_KEY_FILE_DESKTOP_KEY_EXEC: * @@ -11413,6 +11444,7 @@ * attempt to correctly handle %EINTR, which has platform-specific * semantics. * + * Returns: %TRUE on success, %FALSE if there was an error. * Since: 2.36 */ @@ -15176,6 +15208,7 @@ * * Checks if @key is in @hash_table. * + * Returns: %TRUE if @key is in @hash_table, %FALSE otherwise. * Since: 2.32 */ @@ -15311,7 +15344,7 @@ * %NULL was used as the value for a key. * * Note: in the common case of a string-keyed #GHashTable, the return - * value of this function can be conveniently cast to (gchar **). + * value of this function can be conveniently cast to (const gchar **). * * You should always free the return result with g_free(). In the * above-mentioned case of a string-keyed hash table, it may be @@ -21182,6 +21215,7 @@ * * See g_option_context_set_strict_posix() for more information. * + * Returns: %TRUE if strict POSIX is enabled, %FALSE otherwise. * Since: 2.44 */ @@ -21359,6 +21393,7 @@ /** * g_option_context_set_strict_posix: * @context: a #GoptionContext + * @strict_posix: the new value * * Sets strict POSIX mode. * @@ -35803,7 +35838,7 @@ * to #G_MAXSSIZE. * * To print or scan values of this type, use - * %G_GSIZE_MODIFIER and/or %G_GSSIZE_FORMAT. + * %G_GSSIZE_MODIFIER and/or %G_GSSIZE_FORMAT. */ -- cgit v1.2.1