GUPnPRootDevice

GUPnPRootDevice — Class for root device implementations.

Synopsis




                    GUPnPRootDevice;
GUPnPRootDevice*    gupnp_root_device_new               (GUPnPContext *context,
                                                         xmlDoc *description_doc,
                                                         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);


Description

GUPnPRootDevice allows for implementing root devices.

Details

GUPnPRootDevice

typedef struct {
        GUPnPDevice parent;

        GUPnPRootDevicePrivate *priv;
} GUPnPRootDevice;


gupnp_root_device_new ()

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

Create a new GUPnPRootDevice object.

context : The GUPnPContext
description_doc : Pointer to the device description document
relative_location : Location to use 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);

context : A GUPnPContext
factory : A GUPnPResourceFactory
description_doc : Pointer to the device description document
relative_location : Location to use 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);

root_device : A GUPnPRootDevice
Returns : TRUE if root_device is available.

gupnp_root_device_get_relative_location ()

const char*         gupnp_root_device_get_relative_location
                                                        (GUPnPRootDevice *root_device);

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