* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
- * Public License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
*
* Authors: Ryan Lortie <desrt@desrt.ca>
* Alexander Larsson <alexl@redhat.com>
*/
/**
- * SECTION: gsocketservice
+ * SECTION:gsocketservice
* @title: GSocketService
* @short_description: Make it easy to implement a network service
+ * @include: gio/gio.h
* @see_also: #GThreadedSocketService, #GSocketListener.
*
- * A #GSocketService 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 #GSocketService:incoming
+ * A #GSocketService 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 #GSocketService::incoming
* signal is emitted.
*
* A #GSocketService is a subclass of #GSocketListener and you need
- * to add the addresses you want to accept connections on to the
- * with the #GSocketListener APIs.
+ * to add the addresses you want to accept connections on with the
+ * #GSocketListener APIs.
*
* There are two options for implementing a network service based on
* #GSocketService. The first is to create the service using
- * g_socket_service_new() and to connect to the #GSocketService:incoming
+ * g_socket_service_new() and to connect to the #GSocketService::incoming
* signal. The second is to subclass #GSocketService and override the
* default signal handler implementation.
*
* If you are interested in writing connection handlers that contain
* blocking code then see #GThreadedSocketService.
*
- * 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 service are threadsafe so these can be used from threads that
+ * The socket service runs on the main loop of the
+ * [thread-default context][g-main-context-push-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 thread-safe so these can be used from threads that
* handle incoming clients.
*
* Since: 2.22
#include "config.h"
#include "gsocketservice.h"
-#include "gio-marshal.h"
#include <gio/gio.h>
#include "gsocketlistener.h"
#include "gsocketconnection.h"
-
-static guint g_socket_service_incoming_signal;
-
-G_DEFINE_TYPE (GSocketService, g_socket_service, G_TYPE_SOCKET_LISTENER);
-
-G_LOCK_DEFINE_STATIC(active);
-
struct _GSocketServicePrivate
{
GCancellable *cancellable;
guint outstanding_accept : 1;
};
+static guint g_socket_service_incoming_signal;
+
+G_LOCK_DEFINE_STATIC(active);
+
+G_DEFINE_TYPE_WITH_PRIVATE (GSocketService, g_socket_service, G_TYPE_SOCKET_LISTENER)
+
static void g_socket_service_ready (GObject *object,
GAsyncResult *result,
gpointer user_data);
static void
g_socket_service_init (GSocketService *service)
{
- service->priv = G_TYPE_INSTANCE_GET_PRIVATE (service,
- G_TYPE_SOCKET_SERVICE,
- GSocketServicePrivate);
+ service->priv = g_socket_service_get_instance_private (service);
service->priv->cancellable = g_cancellable_new ();
service->priv->active = TRUE;
}
* Starts the service, i.e. start accepting connections
* from the added sockets when the mainloop runs.
*
- * This call is threadsafe, so it may be called from a thread
- * handling an incomming client request.
+ * This call is thread-safe, so it may be called from a thread
+ * handling an incoming client request.
*
* Since: 2.22
*/
* Stops the service, i.e. stops accepting connections
* from the added sockets when the mainloop runs.
*
- * This call is threadsafe, so it may be called from a thread
- * handling an incomming client request.
+ * This call is thread-safe, so it may be called from a thread
+ * handling an incoming client request.
+ *
+ * Note that this only stops accepting new connections; it does not
+ * close the listening sockets, and you can call
+ * g_socket_service_start() again later to begin listening again. To
+ * close the listening sockets, call g_socket_listener_close(). (This
+ * will happen automatically when the #GSocketService is finalized.)
*
* Since: 2.22
*/
GObjectClass *gobject_class = G_OBJECT_CLASS (class);
GSocketListenerClass *listener_class = G_SOCKET_LISTENER_CLASS (class);
- g_type_class_add_private (class, sizeof (GSocketServicePrivate));
-
gobject_class->finalize = g_socket_service_finalize;
listener_class->changed = g_socket_service_changed;
class->incoming = g_socket_service_real_incoming;
/**
* GSocketService::incoming:
- * @service: the #GSocketService.
- * @connection: a new #GSocketConnection object.
- * @source_object: the source_object passed to g_socket_listener_add_address().
+ * @service: the #GSocketService
+ * @connection: a new #GSocketConnection object
+ * @source_object: (allow-none): the source_object passed to
+ * g_socket_listener_add_address()
*
* The ::incoming signal is emitted when a new incoming connection
* to @service needs to be handled. The handler must initiate the
* handling of @connection, but may not block; in essence,
* asynchronous operations must be used.
*
+ * @connection will be unreffed once the signal handler returns,
+ * so you need to ref it yourself if you are planning to use it.
+ *
* Returns: %TRUE to stop other handlers from being called
*
* Since: 2.22
g_signal_new ("incoming", G_TYPE_FROM_CLASS (class), G_SIGNAL_RUN_LAST,
G_STRUCT_OFFSET (GSocketServiceClass, incoming),
g_signal_accumulator_true_handled, NULL,
- _gio_marshal_BOOLEAN__OBJECT_OBJECT, G_TYPE_BOOLEAN,
+ NULL, G_TYPE_BOOLEAN,
2, G_TYPE_SOCKET_CONNECTION, G_TYPE_OBJECT);
}
projects / platform / upstream / glib.git / blobdiff