summaryrefslogtreecommitdiff
path: root/gio/src/socket.hg
diff options
context:
space:
mode:
authorJonathon Jongsma <jonathon@quotidian.org>2010-01-03 22:34:04 -0600
committerJonathon Jongsma <jonathon@quotidian.org>2010-01-03 22:34:04 -0600
commitaa139e5a64fe8b189a20d5ce27fe7bab4899ec5e (patch)
tree6fe6cc6cb429c696e52a3e31f7b8837ad81ae264 /gio/src/socket.hg
parentcb46a81c46bfd794edc4362d89a82c37ba8d2c59 (diff)
downloadglibmm-aa139e5a64fe8b189a20d5ce27fe7bab4899ec5e.tar.gz
A bunch of minor doxygen cleanups around the tree
Mostly correct the 'since 2.24' notation on all of the network classes, and fix up a variety of other little issues.
Diffstat (limited to 'gio/src/socket.hg')
-rw-r--r--gio/src/socket.hg21
1 files changed, 9 insertions, 12 deletions
diff --git a/gio/src/socket.hg b/gio/src/socket.hg
index 64561b6b..3f99c598 100644
--- a/gio/src/socket.hg
+++ b/gio/src/socket.hg
@@ -29,13 +29,13 @@ _PINCLUDE(glibmm/private/object_p.h)
namespace Gio
{
-/** @defgroup NetworkIO Portable Network I/O Functionality
- */
-
_WRAP_ENUM(SocketType, GSocketType)
_WRAP_ENUM(SocketProtocol, GSocketProtocol)
_WRAP_ENUM(SocketMsgFlags, GSocketMsgFlags)
+/** @defgroup NetworkIO Portable Network I/O Functionality
+ */
+
/** Low-level socket object
*
* A Socket is a low-level networking primitive. It is a more or less direct
@@ -48,27 +48,24 @@ _WRAP_ENUM(SocketMsgFlags, GSocketMsgFlags)
* SocketConnection. However there may be cases where direct use of Socket is
* useful.
*
- * (FIXME: update this doc for giomm)
- * Socket implements the Initable interface, so if it is manually constructed by
- * e.g. g_object_new() you must call g_initable_init() and check the results
- * before using the object. This is done automatically in g_socket_new() and
- * g_socket_new_from_fd(), so these functions can return NULL.
+ * Socket implements the Initable interface, and since initialization can fail,
+ * the constructor may throw an exception.
*
* Sockets operate in two general modes, blocking or non-blocking. When in
* blocking mode all operations block until the requested operation is finished
* or there is an error. In non-blocking mode all calls that would block return
- * immediately with a G_IO_ERROR_WOULD_BLOCK error. To know when a call would
+ * immediately with a Gio::Error::WOULD_BLOCK error. To know when a call would
* successfully run you can call condition_check(), or condition_wait(). You can
* also use create_source() and attach it to a Glib::MainContext to get
* callbacks when I/O is possible. Note that all sockets are always set to non
* blocking mode in the system, and blocking mode is emulated in Socket.
*
* When working in non-blocking mode applications should always be able to
- * handle getting a G_IO_ERROR_WOULD_BLOCK error even when some other function
+ * handle getting a Gio::Error::WOULD_BLOCK error even when some other function
* said that I/O was possible. This can easily happen in case of a race
* condition in the application, but it can also happen for other reasons. For
* instance, on Windows a socket is always seen as writable until a write
- * returns G_IO_ERROR_WOULD_BLOCK.
+ * returns Gio::Error::WOULD_BLOCK.
*
* Sockets can be either connection oriented or datagram based. For connection
* oriented types you must first establish a connection by either connecting to
@@ -84,7 +81,7 @@ _WRAP_ENUM(SocketMsgFlags, GSocketMsgFlags)
* automatically be killed if it tries to write to stdout after it has been
* closed.
*
- * @newin{2,22}
+ * @newin{2,24}
* @ingroup NetworkIO
*/
class Socket : public Glib::Object, public Initable