docs: Clarify GSocketClient reuse policy
authorBenjamin Otte <otte@redhat.com>
Wed, 1 Feb 2012 15:25:01 +0000 (16:25 +0100)
committerBenjamin Otte <otte@redhat.com>
Wed, 1 Feb 2012 15:25:23 +0000 (16:25 +0100)
gio/gsocketclient.c

index 1a86bf5..8ff51d7 100644 (file)
@@ -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
+ * 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
  */