luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-20 15:48:54 +02:00
Code Issues Packages Projects Releases Wiki Activity

gsocketconnection: Document closing connections with g_io_stream_close()

Browse Source 
It’s not enough to close a connection by calling g_input_stream_close()
and g_output_stream_close() on its two substreams: to close the
underlying socket, one must use g_io_stream_close(). Document that.

https://bugzilla.gnome.org/show_bug.cgi?id=724278
This commit is contained in:
Philip Withnall
2014-02-13 10:58:21 +00:00
parent 0017728c8c
commit 169846c5ab
2 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
gio/giostream.c
View File

@@ -55,9 +55,9 @@
* To close a stream use g_io_stream_close() which will close the common * To close a stream use g_io_stream_close() which will close the common
* stream object and also the individual substreams. You can also close * stream object and also the individual substreams. You can also close
* the substreams themselves. In most cases this only marks the * the substreams themselves. In most cases this only marks the
* substream as closed, so further I/O on it fails. However, some streams * substream as closed, so further I/O on it fails but common state in the
* may support "half-closed" states where one direction of the stream * #GIOStream may still be open. However, some streams may support
* is actually shut down. * "half-closed" states where one direction of the stream is actually shut down.
* *
* Since: 2.22 * Since: 2.22
*/ */

4
gio/gsocketconnection.c
View File

@@ -56,6 +56,10 @@
* custom socket connection types for specific combination of socket * custom socket connection types for specific combination of socket
* family/type/protocol using g_socket_connection_factory_register_type(). * family/type/protocol using g_socket_connection_factory_register_type().
* *
* To close a #GSocketConnection, use g_io_stream_close(). Closing both
* substreams of the #GIOStream separately will not close the underlying
* #GSocket.
*
* Since: 2.22 * Since: 2.22
*/ */