GUPnPRootDevice

GUPnPRootDevice — Class for root device implementations.

Synopsis

                    GUPnPRootDevice;
GUPnPRootDevice*    gupnp_root_device_new               (GUPnPContext *context,
                                                         const char *relative_location);
GUPnPRootDevice*    gupnp_root_device_new_full          (GUPnPContext *context,
                                                         GUPnPResourceFactory *factory,
                                                         xmlDoc *description_doc,
                                                         const char *relative_location);
void                gupnp_root_device_set_available     (GUPnPRootDevice *root_device,
                                                         gboolean available);
gboolean            gupnp_root_device_get_available     (GUPnPRootDevice *root_device);
const char*         gupnp_root_device_get_relative_location
                                                        (GUPnPRootDevice *root_device);

Object Hierarchy

  GObject
   +----GUPnPDeviceInfo
         +----GUPnPDevice
               +----GUPnPRootDevice

Properties

  "available"                gboolean              : Read / Write
  "description-doc"          gpointer              : Write / Construct Only
  "relative-location"        gchar*                : Read / Write / Construct Only

Description

GUPnPRootDevice allows for implementing root devices.

Details

GUPnPRootDevice

typedef struct _GUPnPRootDevice GUPnPRootDevice;

This struct contains private data only, and should be accessed using the functions below.

gupnp_root_device_new ()

GUPnPRootDevice*    gupnp_root_device_new               (GUPnPContext *context,
                                                         const char *relative_location);

Create a new GUPnPRootDevice object, automatically downloading and parsing relative_location.

context : The GUPnPContext
relative_location : Location of the description file for this device, relative to the HTTP root
Returns : A new GUPnPRootDevice object.

gupnp_root_device_new_full ()

GUPnPRootDevice*    gupnp_root_device_new_full          (GUPnPContext *context,
                                                         GUPnPResourceFactory *factory,
                                                         xmlDoc *description_doc,
                                                         const char *relative_location);

Create a new GUPnPRootDevice, automatically downloading and parsing relative_location if description_doc is NULL.

context : A GUPnPContext
factory : A GUPnPResourceFactory
description_doc : Pointer to the device description document, or NULL
relative_location : Location of the description file for this device, relative to the HTTP root
Returns : A new GUPnPRootDevice object.

gupnp_root_device_set_available ()

void                gupnp_root_device_set_available     (GUPnPRootDevice *root_device,
                                                         gboolean available);

Controls whether or not root_device is available (announcing its presence).

root_device : A GUPnPRootDevice
available : TRUE if root_device should be available

gupnp_root_device_get_available ()

gboolean            gupnp_root_device_get_available     (GUPnPRootDevice *root_device);

Get whether or not root_device is available (announcing its presence).

root_device : A GUPnPRootDevice
Returns : TRUE if root_device is available, FALSE otherwise.

gupnp_root_device_get_relative_location ()

const char*         gupnp_root_device_get_relative_location
                                                        (GUPnPRootDevice *root_device);

Get the relative location of root_device.

root_device : A GUPnPRootDevice
Returns : The relative location of root_device.

Property Details

The "available" property

  "available"                gboolean              : Read / Write

TRUE if this device is available.

Default value: FALSE

The "description-doc" property

  "description-doc"          gpointer              : Write / Construct Only

Pointer to description document. Constructor property.

The "relative-location" property

  "relative-location"        gchar*                : Read / Write / Construct Only

Relative location.

Default value: NULL

Generated by GTK-Doc V1.10