GUPnP.ServiceIntrospection¶

Subclasses:: None

Methods¶

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

	`get_action` (action_name)
	`get_state_variable` (variable_name)
	`list_action_names` ()
	`list_actions` ()
	`list_state_variable_names` ()
	`list_state_variables` ()

Virtual Methods¶

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

Properties¶

Name	Type	Flags	Short Description
`scpd`	`int`	w/co	Pointer to SCPD

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class GUPnP.ServiceIntrospection(**kwargs)¶

Bases:: GObject.Object, Gio.Initable
Abstract:: No
Structure:: GUPnP.ServiceIntrospectionClass

Introspection of local and remote services..

The GUPnP.ServiceIntrospection class provides methods for service introspection based on information contained in its service description document (SCPD). There is no constructor provided for this class, please use [method`GUPnP`.ServiceInfo.introspect_async] to create a GUPnP.ServiceIntrospection object for a specific service.

Note that all the introspection information is retrieved from the service description document (SCPD) provided by the service and hence can not be guaranteed to be complete. An UPnP service is required to provide a SCPD but unfortunately, many services either do not provide this document or the document does not provide any or all of the introspection information.

This class exposes internals of the UPnP protocol and should not need to be used for regular device or control point development.

get_action(action_name)¶

Parameters:: action_name (str) – The name of the action to retrieve
Returns:: the action or None. Do not modify or free it.
Return type:: GUPnP.ServiceActionInfo or None

Returns the action by the name action_name in this service.

get_state_variable(variable_name)¶

Parameters:: variable_name (str) – The name of the variable to retrieve
Returns:: the state variable or None. Do not modify or free it.
Return type:: GUPnP.ServiceStateVariableInfo or None

Returns the state variable by the name variable_name in this service.

list_action_names()¶

Returns:: A GLib.List of names of all the actions or None. Do not modify or free it or its contents.
Return type:: [str]

Returns a GLib.List of names of all the actions in this service.

list_actions()¶

Returns:: A GLib.List of all the actions or None. Do not modify or free it or its contents.
Return type:: [GUPnP.ServiceActionInfo]

Returns a GLib.List of all the actions (of type GUPnP.ServiceActionInfo) in this service.

list_state_variable_names()¶

Returns:: A GLib.List of names of all the state variables or None. Do not modify or free it or its contents.
Return type:: [str]

Returns a GLib.List of names of all the state variables in this service.

list_state_variables()¶

Returns:: A GLib.List of all the state variables or None. Do not modify or free it or its contents.
Return type:: [GUPnP.ServiceStateVariableInfo]

Returns a GLib.List of all the state variables (of type GUPnP.ServiceStateVariableInfo) in this service.

Property Details¶

GUPnP.ServiceIntrospection.props.scpd¶

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

The scpd of the device description file.