GUPnP.ServiceInfo¶

Subclasses:: GUPnP.Service, GUPnP.ServiceProxy

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_context` ()
	`get_control_url` ()
	`get_event_subscription_url` ()
	`get_id` ()
	`get_location` ()
	`get_scpd_url` ()
	`get_service_type` ()
	`get_udn` ()
	`get_url_base` ()
	`introspect_async` (cancellable, callback, *user_data)
	`introspect_finish` (res)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`context`	`GUPnP.Context`	r/w/co	The `GUPnP.Context`.
`document`	`GUPnP.XMLDoc`	w/co	The XML document related to this service
`element`	`int`	w/co	The XML element related to this device
`location`	`str`	r/w/co	The location of the device description file
`service-type`	`str`	r/w/co	The service type
`udn`	`str`	r/w/co	The UDN of the containing device
`url-base`	`GLib.Uri`	r/w/co	The URL base

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class GUPnP.ServiceInfo(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: GUPnP.ServiceInfoClass

Service information shared by local and remote services.

A class that contains the common parts between local and remote services.

get_context()¶

Returns:: A GUPnP.Context.
Return type:: GUPnP.Context

Get the GUPnP.Context associated with self.

get_control_url()¶

Returns:: A string. This string should be freed with GLib.free() after use.
Return type:: str

Get the control URL for this service, or None..

get_event_subscription_url()¶

Returns:: A string. This string should be freed with GLib.free() after use.
Return type:: str

Get the event subscription URL for this service, or None.

get_id()¶

Returns:: A string. This string should be freed with GLib.free() after use.
Return type:: str

Get the serviceID of this service, or None if there is no ID.

The serviceID should be unique to a device. This makes it possible to provide the same serviceType multiple times on one device

Example: org:serviceId:RenderingControl

get_location()¶

Returns:: A constant string.
Return type:: str

Get the location of the device description file.

get_scpd_url()¶

Returns:: A string. This string should be freed with GLib.free() after use.
Return type:: str

Get the SCPD URL for this service, or None if there is no SCPD.

get_service_type()¶

Returns:: A constant string.
Return type:: str

Get the UPnP service type, or None.

Example: urn:schemas-upnp-org:service:RenderingControl:1

get_udn()¶

Returns:: A constant string.
Return type:: str

Get the Unique Device Name of the containing device.

get_url_base()¶

Returns:: A constant #SoupURI.
Return type:: GLib.Uri

Get the URL base of this service.

introspect_async(cancellable, callback, *user_data)¶

Parameters:

cancellable (Gio.Cancellable or None) – a Gio.Cancellable that can be used to cancel the call.
callback (Gio.AsyncReadyCallback or None) – callback to be called when introspection object is ready.
user_data (object or None) – user_data to be passed to the callback.

Note that introspection object is created from the information in service description document (SCPD) provided by the service so it can not be created if the service does not provide a SCPD.

If cancellable is used to cancel the call, callback will be called with error code Gio.IOErrorEnum.CANCELLED.

New in version 1.2.2.

introspect_finish(res)¶

Parameters:: res (Gio.AsyncResult) – A Gio.AsyncResult
Raises:: GLib.Error
Returns:: None, if the call had an error, a GUPnP.ServiceIntrospection object otherwise.
Return type:: GUPnP.ServiceIntrospection or None

Finish an asynchronous call initiated with GUPnP.ServiceInfo.introspect_async().

New in version 1.2.2.

Property Details¶

GUPnP.ServiceInfo.props.context¶

Name:: context
Type:: GUPnP.Context
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The GUPnP.Context to use.

GUPnP.ServiceInfo.props.document¶

Name:: document
Type:: GUPnP.XMLDoc
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

Private property.

GUPnP.ServiceInfo.props.element¶

Name:: element
Type:: int
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

Private property.

GUPnP.ServiceInfo.props.location¶

Name:: location
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The location of the device description file.

GUPnP.ServiceInfo.props.service_type¶

Name:: service-type
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The service type.

GUPnP.ServiceInfo.props.udn¶

Name:: udn
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The UDN of the containing device.

GUPnP.ServiceInfo.props.url_base¶

Name:: url-base
Type:: GLib.Uri
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The URL base (#SoupURI).