[glib] docs: Clarify GSocketClient reuse policy
- From: Benjamin Otte <otte src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] docs: Clarify GSocketClient reuse policy
- Date: Wed, 1 Feb 2012 15:29:24 +0000 (UTC)
commit 053b011cccdf8463a10ae09799dd43048bb6c9f0
Author: Benjamin Otte <otte redhat com>
Date: Wed Feb 1 16:25:01 2012 +0100
docs: Clarify GSocketClient reuse policy
gio/gsocketclient.c | 7 +++++--
1 files changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/gio/gsocketclient.c b/gio/gsocketclient.c
index 1a86bf5..8ff51d7 100644
--- a/gio/gsocketclient.c
+++ b/gio/gsocketclient.c
@@ -56,8 +56,8 @@
* @include: gio/gio.h
* @see_also: #GSocketConnection, #GSocketListener
*
- * #GSocketClient is a high-level utility class for connecting to a
- * network host using a connection oriented socket type.
+ * #GSocketClient is a lightweight high-level utility class for connecting to
+ * a network host using a connection oriented socket type.
*
* You create a #GSocketClient object, set any options you want, and then
* call a sync or async connect operation, which returns a #GSocketConnection
@@ -67,6 +67,9 @@
* the underlying socket that is in use. For instance, for a TCP/IP connection
* it will be a #GTcpConnection.
*
+ * As #GSocketClient is a lightweight object, you don't need to cache it. You
+ * can just create a new one any time you need one.
+ *
* Since: 2.22
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]