gmyth-upnp/src/gmyth_upnp.h
author rosfran
Thu May 24 01:26:10 2007 +0100 (2007-05-24)
branchtrunk
changeset 706 5cc97240e238
parent 700 9ade4c5e5db8
child 754 cb885ee44618
permissions -rw-r--r--
[svn r712] GObject's signal handling on receiving UPnP device notifications.
     1 /**
     2  * GMyth Library
     3  *
     4  * @file gmyth/gmyth_upnp.h
     5  * 
     6  * @brief <p> GMythUPnP allows that a MythTV frontend discovers a 
     7  * MythTV backend, using the UPnP architecture.
     8  *
     9  * Copyright (C) 2006 INdT - Instituto Nokia de Tecnologia.
    10  * @author Rosfran Lins Borges <rosfran.borges@indt.org.br>
    11  *
    12  * This program is free software; you can redistribute it and/or modify
    13  * it under the terms of the GNU Lesser General Public License as published by
    14  * the Free Software Foundation; either version 2 of the License, or
    15  * (at your option) any later version.
    16  *
    17  * This program is distributed in the hope that it will be useful,
    18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    20  * GNU General Public License for more details.
    21  *
    22  * You should have received a copy of the GNU Lesser General Public License
    23  * along with this program; if not, write to the Free Software
    24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    25  *   
    26  */
    27 
    28 #ifndef _GMYTH_UPNP_H_
    29 #define _GMYTH_UPNP_H_
    30 
    31 #include <glib.h>
    32 #include <glib-object.h>
    33 
    34 #include <stdlib.h>
    35 #include <stdio.h>
    36 #include <string.h>
    37 
    38 #include <cybergarage/upnp/cupnp.h>
    39 #include <gmyth/gmyth_backendinfo.h>
    40 
    41 G_BEGIN_DECLS
    42 
    43 #define GMYTH_UPNP_TYPE               (gmyth_upnp_get_type ())
    44 #define GMYTH_UPNP(obj)          		 	(G_TYPE_CHECK_INSTANCE_CAST ((obj), GMYTH_UPNP_TYPE, GMythUPnP))
    45 #define GMYTH_UPNP_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GMYTH_UPNP_TYPE, GMythUPnPClass))
    46 #define IS_GMYTH_UPNP(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GMYTH_UPNP_TYPE))
    47 #define IS_GMYTH_UPNP_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GMYTH_UPNP_TYPE))
    48 #define GMYTH_UPNP_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), GMYTH_UPNP_TYPE, GMythUPnPClass))
    49 
    50 typedef struct _GMythUPnP         GMythUPnP;
    51 typedef struct _GMythUPnPClass    GMythUPnPClass;
    52 typedef struct _GMythUPnPPrivate  GMythUPnPPrivate;
    53 
    54 /****************************************
    55 * Data Type
    56 ****************************************/
    57 
    58 typedef enum upnp_device_list_status {
    59 	GMYTH_UPNP_DEVICE_ADDED = 0,
    60 	GMYTH_UPNP_DEVICE_UPDATED,
    61 	GMYTH_UPNP_DEVICE_REMOVED
    62 } GMythUPnPDeviceStatus;
    63 
    64 typedef void (*GMythUPnPDeviceListener) ( GMythUPnP *gmyth_upnp, GMythUPnPDeviceStatus status, gchar *dev );
    65 
    66 struct _GMythUPnPClass
    67 {
    68 	GObjectClass parent_class;
    69 
    70 	/* callbacks */
    71 	guint device_found_handler_signal_id;
    72 
    73 	GMythUPnPDeviceListener device_found_handler;
    74 
    75 	/* no one for now */
    76 };
    77 
    78 struct _GMythUPnPDevice {
    79 	gchar *uri;
    80 	gchar *host;
    81 	gint port;
    82 	gchar *protocol;
    83 };
    84 
    85 typedef struct _GMythUPnPDevice GMythUPnPDevice;
    86 
    87 struct _GMythUPnP {
    88 	
    89 	GObject parent;
    90 	GMythUPnPPrivate *priv;
    91 	
    92 
    93 	CgUpnpControlPoint* control_point;
    94 	
    95 	gchar *udn;
    96 	
    97 	GMythBackendInfo *backend_info;
    98 
    99 	gboolean upnp_dev_found;
   100 };
   101 
   102 GType       			gmyth_upnp_get_type (void);
   103 GMythUPnP *			gmyth_upnp_new ( GMythBackendInfo *gmyth_backend_info, 
   104 						GMythUPnPDeviceListener handler );
   105 
   106 GList *				gmyth_upnp_do_search_sync( GMythUPnP* gmyth_upnp );
   107 
   108 GMythBackendInfo*		gmyth_upnp_get_backend_info ( GMythUPnP *gmyth_upnp );
   109 
   110 gchar *				gmyth_upnp_device_status_to_string( GMythUPnPDeviceStatus status );
   111 
   112 G_END_DECLS
   113 
   114 #endif /* _GMYTH_UPNP_H_ */