From d78682c3ed52c0f013a9bfe2a4bb7e5ee9fb408f Mon Sep 17 00:00:00 2001 From: Kjell Ahlstedt Date: Sat, 6 Aug 2016 09:32:31 +0200 Subject: Gio::SocketService: Update the class documentation * gio/src/socketservice.hg: The documentation of GSocketService has been slightly modified. Modify the documentation of Gio::SocketService accordingly. Fix the indentation. Noticed in connection with bug #766151, but not a bug fix. --- gio/src/socketservice.hg | 43 ++++++++++++++++++++----------------------- 1 file changed, 20 insertions(+), 23 deletions(-) (limited to 'gio') diff --git a/gio/src/socketservice.hg b/gio/src/socketservice.hg index b8cb5c57..cc025ca3 100644 --- a/gio/src/socketservice.hg +++ b/gio/src/socketservice.hg @@ -1,5 +1,3 @@ -// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*- - /* Copyright (C) 2010 Jonathon Jongsma * * This library is free software; you can redistribute it and/or @@ -25,33 +23,32 @@ _PINCLUDE(giomm/private/socketlistener_p.h) namespace Gio { -/** - * Make it easy to implement a network service +/** Make it easy to implement a network service. * * @see ThreadedSocketService, SocketListener. * - * A SocketService is an object that represents a service that is + * A %SocketService is an object that represents a service that is * provided to the network or over local sockets. When a new - * connection is made to the service the SocketService:incoming - * signal is emitted. + * connection is made to the service signal_incoming() is emitted. * - * A SocketService is a subclass of SocketListener and you need - * to add the addresses you want to accept connections on to the - * with the SocketListener APIs. + * A %SocketService is a subclass of SocketListener and you need + * to add the addresses you want to accept connections on with the + * SocketListener APIs. * * There are two options for implementing a network service based on - * SocketService. The first is to create the service using - * g_socket_service_new() and to connect to the SocketService:incoming - * signal. The second is to subclass SocketService and override the - * default signal handler implementation. + * %SocketService. The first is to create the service using + * create() and to connect to signal_incoming(). + * The second is to subclass %SocketService and override the + * default signal handler implementation, on_incoming(). * * In either case, the handler must immediately return, or else it * will block additional incoming connections from being serviced. * If you are interested in writing connection handlers that contain * blocking code then see ThreadedSocketService. * - * The socket service runs on the main loop in the main thread, and is - * not threadsafe in general. However, the calls to start and stop + * The socket service runs on the main loop of the thread-default context + * of the thread it is created in, and is not + * threadsafe in general. However, the calls to start and stop * the service are threadsafe so these can be used from threads that * handle incoming clients. * @@ -60,20 +57,20 @@ namespace Gio */ class SocketService : public Gio::SocketListener { - _CLASS_GOBJECT(SocketService, GSocketService, G_SOCKET_SERVICE, Gio::SocketListener, GSocketListener) + _CLASS_GOBJECT(SocketService, GSocketService, G_SOCKET_SERVICE, Gio::SocketListener, GSocketListener) protected: - _CTOR_DEFAULT + _CTOR_DEFAULT public: - _WRAP_CREATE() - _WRAP_METHOD(void start(), g_socket_service_start) - _WRAP_METHOD(void stop(), g_socket_service_stop) - _WRAP_METHOD(bool is_active(), g_socket_service_is_active) + _WRAP_CREATE() + _WRAP_METHOD(void start(), g_socket_service_start) + _WRAP_METHOD(void stop(), g_socket_service_stop) + _WRAP_METHOD(bool is_active(), g_socket_service_is_active) #m4 _CONVERSION(`GObject*',`const Glib::RefPtr&',`Glib::wrap($3, true)') #m4 _CONVERSION(`GSocketConnection*',`const Glib::RefPtr&',`Glib::wrap($3, true)') - _WRAP_SIGNAL(bool incoming(const Glib::RefPtr& connection, const Glib::RefPtr& source_object), "incoming") + _WRAP_SIGNAL(bool incoming(const Glib::RefPtr& connection, const Glib::RefPtr& source_object), "incoming") _WRAP_PROPERTY("active", bool, newin "2,46") }; -- cgit v1.2.1