libbeagle/beagle/beagle-client.c

   1 /*
   2  * beagle-client.c
   3  *
   4  * Copyright (C) 2005 Novell, Inc.
   5  *
   6  */
   7
   8 /*
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  25  * DEALINGS IN THE SOFTWARE.
  26  */
  27
  28 #include <stdlib.h>
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <sys/socket.h>
  32 #include <sys/un.h>
  33
  34 #include "beagle-private.h"
  35 #include "beagle-client.h"
  36 #include "beagle-util.h"
  37
  38 typedef struct {
  39         gchar *socket_path;
  40 } BeagleClientPrivate;
  41
  42 #define BEAGLE_CLIENT_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), BEAGLE_TYPE_CLIENT, BeagleClientPrivate))
  43
  44 static GObjectClass *parent_class = NULL;
  45
  46 G_DEFINE_TYPE (BeagleClient, beagle_client, G_TYPE_OBJECT)
  47
  48 static void
  49 beagle_client_finalize (GObject *obj)
  50 {
  51         BeagleClientPrivate *priv = BEAGLE_CLIENT_GET_PRIVATE (obj);
  52
  53         g_free (priv->socket_path);
  54
  55         if (G_OBJECT_CLASS (parent_class)->finalize)
  56                 G_OBJECT_CLASS (parent_class)->finalize (obj);
  57 }
  58
  59 static void
  60 beagle_client_class_init (BeagleClientClass *klass)
  61 {
  62         GObjectClass *obj_class = G_OBJECT_CLASS (klass);
  63
  64         parent_class = g_type_class_peek_parent (klass);
  65
  66         obj_class->finalize = beagle_client_finalize;
  67
  68         g_type_class_add_private (klass, sizeof (BeagleClientPrivate));
  69 }
  70
  71 static void
  72 beagle_client_init (BeagleClient *client)
  73 {
  74 }
  75
  76 /**
  77  * beagle_client_new:
  78  * @client_name: a string
  79  *
  80  * Creates a new #BeagleClient. If @client_name is %NULL it will default to "socket".
  81  *
  82  * Return value: a newly created #BeagleClient, or NULL if the client cannot be created.
  83  **/
  84 BeagleClient *
  85 beagle_client_new (const char *client_name)
  86 {
  87         BeagleClient *client;
  88         BeagleClientPrivate *priv;
  89         gchar *socket_path;
  90
  91         socket_path = beagle_util_get_socket_path (client_name);
  92
  93         if (socket_path == NULL)
  94                 return NULL;
  95
  96         client = g_object_new (BEAGLE_TYPE_CLIENT, 0);
  97         priv = BEAGLE_CLIENT_GET_PRIVATE (client);
  98         priv->socket_path = socket_path;
  99
 100         return client;
 101 }
 102
 103 /**
 104  * beagle_client_new_from_socket_path:
 105  * @socket_path: a string of the path to the daemon socket
 106  *
 107  * Creates a new #BeagleClient, connecting to the path with @socket_path. NULL
 108  * is not allowed.
 109  *
 110  * Return value: a newly created #BeagleClient, or NULL if the client cannot be created.
 111  **/
 112 BeagleClient *
 113 beagle_client_new_from_socket_path (const char *socket_path)
 114 {
 115         BeagleClient *client;
 116         BeagleClientPrivate *priv;
 117         struct stat buf;
 118
 119         if (stat (socket_path, &buf) == -1 || !S_ISSOCK (buf.st_mode))
 120                 return NULL;
 121
 122         client = g_object_new (BEAGLE_TYPE_CLIENT, 0);
 123         priv = BEAGLE_CLIENT_GET_PRIVATE (client);
 124         priv->socket_path = g_strdup (socket_path);
 125
 126         return client;
 127 }
 128
 129 /**
 130  * beagle_client_send_request:
 131  * @client: a #BeagleClient
 132  * @request: a #BeagleRequest
 133  * @err: a location to return an error #GError of type #GIOChannelError.
 134  *
 135  * Synchronously send a #BeagleRequest using the given #BeagleClient.
 136  *
 137  * Return value: a #BeagleResponse.
 138  **/
 139 BeagleResponse *
 140 beagle_client_send_request (BeagleClient   *client,
 141                             BeagleRequest  *request,
 142                             GError        **err)
 143 {
 144         BeagleClientPrivate *priv;
 145
 146         g_return_val_if_fail (BEAGLE_IS_CLIENT (client), NULL);
 147         g_return_val_if_fail (BEAGLE_IS_REQUEST (request), NULL);
 148
 149         priv = BEAGLE_CLIENT_GET_PRIVATE (client);
 150
 151         return _beagle_request_send (request, priv->socket_path, err);
 152 }
 153
 154 /**
 155  * beagle_client_send_request_async:
 156  * @client: a #BeagleClient
 157  * @request: a #BeagleRequest
 158  * @err: a location to store a #GError of type #GIOChannelError
 159  *
 160  * Asynchronously send a #BeagleRequest using the given #BeagleClient.
 161  *
 162  * Return value: %TRUE on success and otherwise %FALSE.
 163  **/
 164 gboolean
 165 beagle_client_send_request_async (BeagleClient   *client,
 166                                   BeagleRequest  *request,
 167                                   GError        **err)
 168 {
 169         BeagleClientPrivate *priv;
 170
 171         g_return_val_if_fail (BEAGLE_IS_CLIENT (client), FALSE);
 172         g_return_val_if_fail (BEAGLE_IS_REQUEST (request), FALSE);
 173
 174         priv = BEAGLE_CLIENT_GET_PRIVATE (client);
 175
 176         return _beagle_request_send_async (request, priv->socket_path, err);
 177 }
 178