libgupnp/gupnp-service-info.h

   1 /*
   2  * Copyright (C) 2006, 2007 OpenedHand Ltd.
   3  *
   4  * Author: Jorn Baayen <jorn@openedhand.com>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 #ifndef __GUPNP_SERVICE_INFO_H__
  23 #define __GUPNP_SERVICE_INFO_H__
  24
  25 #include <glib-object.h>
  26 #include <libxml/tree.h>
  27 #include <libsoup/soup-uri.h>
  28
  29 #include "gupnp-context.h"
  30 #include "gupnp-service-introspection.h"
  31
  32 G_BEGIN_DECLS
  33
  34 GType
  35 gupnp_service_info_get_type (void) G_GNUC_CONST;
  36
  37 #define GUPNP_TYPE_SERVICE_INFO \
  38                 (gupnp_service_info_get_type ())
  39 #define GUPNP_SERVICE_INFO(obj) \
  40                 (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  41                  GUPNP_TYPE_SERVICE_INFO, \
  42                  GUPnPServiceInfo))
  43 #define GUPNP_SERVICE_INFO_CLASS(obj) \
  44                 (G_TYPE_CHECK_CLASS_CAST ((obj), \
  45                  GUPNP_TYPE_SERVICE_INFO, \
  46                  GUPnPServiceInfoClass))
  47 #define GUPNP_IS_SERVICE_INFO(obj) \
  48                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
  49                  GUPNP_TYPE_SERVICE_INFO))
  50 #define GUPNP_IS_SERVICE_INFO_CLASS(obj) \
  51                 (G_TYPE_CHECK_CLASS_TYPE ((obj), \
  52                  GUPNP_TYPE_SERVICE_INFO))
  53 #define GUPNP_SERVICE_INFO_GET_CLASS(obj) \
  54                 (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  55                  GUPNP_TYPE_SERVICE_INFO, \
  56                  GUPnPServiceInfoClass))
  57
  58 typedef struct _GUPnPServiceInfoPrivate GUPnPServiceInfoPrivate;
  59
  60 /**
  61  * GUPnPServiceInfo:
  62  *
  63  * This struct contains private data only, and should be accessed using the
  64  * functions below.
  65  */
  66 typedef struct {
  67         GObject parent;
  68
  69         GUPnPServiceInfoPrivate *priv;
  70 } GUPnPServiceInfo;
  71
  72 typedef struct {
  73         GObjectClass parent_class;
  74
  75         /* future padding */
  76         void (* _gupnp_reserved1) (void);
  77         void (* _gupnp_reserved2) (void);
  78         void (* _gupnp_reserved3) (void);
  79         void (* _gupnp_reserved4) (void);
  80 } GUPnPServiceInfoClass;
  81
  82 /**
  83  * GUPnPServiceIntrospectionCallback
  84  * @info: The #GUPnPServiceInfo introspection was requested for
  85  * @introspection: The new #GUPnPServiceIntrospection object, or NULL
  86  * @error: The #GError that occurred, or NULL
  87  * @user_data: User data
  88  *
  89  * Callback notifying that @introspection for @info has been obtained.
  90  **/
  91 typedef void (* GUPnPServiceIntrospectionCallback) (
  92                                  GUPnPServiceInfo           *info,
  93                                  GUPnPServiceIntrospection  *introspection,
  94                                  const GError               *error,
  95                                  gpointer                    user_data);
  96
  97 GUPnPContext *
  98 gupnp_service_info_get_context                (GUPnPServiceInfo *info);
  99
 100 const char *
 101 gupnp_service_info_get_location               (GUPnPServiceInfo *info);
 102
 103 const SoupURI *
 104 gupnp_service_info_get_url_base               (GUPnPServiceInfo *info);
 105
 106 const char *
 107 gupnp_service_info_get_udn                    (GUPnPServiceInfo *info);
 108
 109 const char *
 110 gupnp_service_info_get_service_type           (GUPnPServiceInfo *info);
 111
 112 char *
 113 gupnp_service_info_get_id                     (GUPnPServiceInfo *info);
 114
 115 char *
 116 gupnp_service_info_get_scpd_url               (GUPnPServiceInfo *info);
 117
 118 char *
 119 gupnp_service_info_get_control_url            (GUPnPServiceInfo *info);
 120
 121 char *
 122 gupnp_service_info_get_event_subscription_url (GUPnPServiceInfo *info);
 123
 124 GUPnPServiceIntrospection *
 125 gupnp_service_info_get_introspection          (GUPnPServiceInfo *info,
 126                                                GError          **error);
 127
 128 void
 129 gupnp_service_info_get_introspection_async
 130                               (GUPnPServiceInfo                 *info,
 131                                GUPnPServiceIntrospectionCallback callback,
 132                                gpointer                          user_data);
 133
 134 G_END_DECLS
 135
 136 #endif /* __GUPNP_SERVICE_INFO_H__ */