GUPnP.RootDevice¶

Subclasses:: None

Methods¶

Inherited:: GUPnP.DeviceInfo (28), GObject.Object (37), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

class	`new` (context, description_path, description_folder)
class	`new_full` (context, factory, description_doc, description_path, description_folder)
	`get_available` ()
	`get_description_dir` ()
	`get_description_document_name` ()
	`get_description_path` ()
	`get_ssdp_resource_group` ()
	`set_available` (available)

Virtual Methods¶

Inherited:: GObject.Object (7), Gio.Initable (1)

Properties¶

Inherited:: GUPnP.Device (1), GUPnP.DeviceInfo (8)

Name	Type	Flags	Short Description
`available`	`bool`	r/w	Whether this device is available
`description-dir`	`str`	r/w/co	The path to directory where description documents are provided
`description-path`	`str`	r/w/co	The path to device description document

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GUPnP.Device`	r

Class Details¶

class GUPnP.RootDevice(**kwargs)¶

Bases:: GUPnP.Device, Gio.Initable
Abstract:: No
Structure:: GUPnP.RootDeviceClass

Implementation of an UPnP root device.

GUPnP.RootDevice allows for implementing root devices.

classmethod new(context, description_path, description_folder)¶

Parameters:

context (GUPnP.Context) – The GUPnP.Context
description_path (str) – Path to device description document. This could either be an absolute path or path relative to description_folder.
description_folder (str) – Path to directory where description documents are provided.

Raises:

GLib.Error

Returns:

A new GUPnPRootDevice object.

Return type:

GUPnP.RootDevice

Create a new GUPnP.RootDevice object, automatically loading and parsing device description document from description_path.

classmethod new_full(context, factory, description_doc, description_path, description_folder)¶

Parameters:

context (GUPnP.Context) – A GUPnP.Context
factory (GUPnP.ResourceFactory) – A GUPnP.ResourceFactory
description_doc (GUPnP.XMLDoc) – Device description document, or None
description_path (str) – Path to device description document. This could either be an absolute path or path relative to description_dir.
description_folder (str) – Path to folder where description documents are provided.

Raises:

GLib.Error

Returns:

A new GUPnP.RootDevice object.

Return type:

GUPnP.RootDevice

Create a new GUPnP.RootDevice, automatically loading and parsing device description document from description_path if description_doc is None.

get_available()¶

Returns:: True if self is available, False otherwise.
Return type:: bool

Checks whether self is available on the network (announcing its presence).

get_description_dir()¶

Returns:: The path to description document directory of self.
Return type:: str

Gets the path to the directory containing description documents related to self.

get_description_document_name()¶

Returns:: The relative location of self.
Return type:: str

Gets the name of the description document as hosted via HTTP.

get_description_path()¶

Returns:: The path to device description document of self.
Return type:: str

Gets the path to the device description document of self.

get_ssdp_resource_group()¶

Returns:: The GSSDP.ResourceGroup of self.
Return type:: GSSDP.ResourceGroup

Gets the GSSDP.ResourceGroup used by self.

New in version 0.20.0.

set_available(available)¶

Parameters:: available (bool) – True if self should be available

Sets the availability of self on the network (announcing its presence).

Property Details¶

GUPnP.RootDevice.props.available¶

Name:: available
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

True if this device is available.

GUPnP.RootDevice.props.description_dir¶

Name:: description-dir
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The path to a folder where description documents are provided.

GUPnP.RootDevice.props.description_path¶

Name:: description-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The path to device description document. This could either be an absolute path or path relative to GUPnP.RootDevice :description-dir.

New in version 0.13.0.