socketservice: Document that it starts pre-activated.

https://bugzilla.gnome.org/show_bug.cgi?id=728207
This commit is contained in:
Olivier Crête 2014-04-14 15:48:41 -04:00 committed by Matthias Clasen
parent 48ea710ee3
commit e3e3ed0d7d

View File

@ -251,8 +251,10 @@ g_socket_service_is_active (GSocketService *service)
* g_socket_service_start: * g_socket_service_start:
* @service: a #GSocketService * @service: a #GSocketService
* *
* Starts the service, i.e. start accepting connections * Restarts the service, i.e. start accepting connections
* from the added sockets when the mainloop runs. * from the added sockets when the mainloop runs. This only needs
* to be called after the service has been stopped from
* g_socket_service_stop().
* *
* This call is thread-safe, so it may be called from a thread * This call is thread-safe, so it may be called from a thread
* handling an incoming client request. * handling an incoming client request.
@ -283,6 +285,10 @@ g_socket_service_start (GSocketService *service)
* close the listening sockets, call g_socket_listener_close(). (This * close the listening sockets, call g_socket_listener_close(). (This
* will happen automatically when the #GSocketService is finalized.) * will happen automatically when the #GSocketService is finalized.)
* *
* This must be called before calling g_socket_listener_close() as
* the socket service will start accepting connections immediately
* when a new socket is added.
*
* Since: 2.22 * Since: 2.22
*/ */
void void
@ -401,6 +407,10 @@ g_socket_service_ready (GObject *object,
* New listeners can be added with e.g. g_socket_listener_add_address() * New listeners can be added with e.g. g_socket_listener_add_address()
* or g_socket_listener_add_inet_port(). * or g_socket_listener_add_inet_port().
* *
* New services are created active, there is no need to call
* g_socket_service_start(), unless g_socket_service_stop() has been
* called before.
*
* Returns: a new #GSocketService. * Returns: a new #GSocketService.
* *
* Since: 2.22 * Since: 2.22