From 6fc3545a87da33a79087c15758dd0652771201dc Mon Sep 17 00:00:00 2001
From: Mark Ryan
GUPnPContext implements
- GInitable.Synopsis
struct GUPnPContext;
-GUPnPContext * gupnp_context_new (
@@ -74,8 +74,8 @@ const char *
GMainContext *main_context
,
+GUPnPContext * gupnp_context_new (GMainContext *main_context
,
const char *interface
,
- guint port
,
- GError **error
);
+ guint port
,
+ GError **error
);
const char * gupnp_context_get_host_ip (GUPnPContext *context
);
-guint gupnp_context_get_port (GUPnPContext *context
);
+guint gupnp_context_get_port (GUPnPContext *context
);
SoupServer * gupnp_context_get_server (GUPnPContext *context
);
SoupSession * gupnp_context_get_session (GUPnPContext *context
);
void gupnp_context_set_subscription_timeout
(GUPnPContext *context
,
- guint timeout
);
-guint gupnp_context_get_subscription_timeout
+ guint timeout
);
+guint gupnp_context_get_subscription_timeout
(GUPnPContext *context
);
const char * gupnp_context_get_default_language (GUPnPContext *context
);
void gupnp_context_set_default_language (GUPnPContext *context
,
@@ -63,10 +63,10 @@ const char * void gupnp_context_host_path (GUPnPContext *context
,
const char *local_path
,
const char *server_path
);
-gboolean gupnp_context_host_path_for_agent (GUPnPContext *context
,
+gboolean gupnp_context_host_path_for_agent (GUPnPContext *context
,
const char *local_path
,
const char *server_path
,
- GRegex *user_agent
);
+ GRegex *user_agent
);
void gupnp_context_unhost_path (GUPnPContext *context
,
const char *server_path
);
Object Hierarchy
- GObject
- +----GSSDPClient
+ GObject
+ +----GSSDPClient
+----GUPnPContext
Implemented Interfaces
- "default-language" gchar* : Read / Write / Construct - "port" guint : Read / Write / Construct Only + "default-language" gchar* : Read / Write / Construct + "port" guint : Read / Write / Construct Only "server" SoupServer* : Read "session" SoupSession* : Read - "subscription-timeout" guint : Read / Write / Construct Only + "subscription-timeout" guint : Read / Write / Construct Only
GUPnPContext * gupnp_context_new (GMainContext *main_context
, +GUPnPContext * gupnp_context_new (+GMainContext *main_context
,const char *interface
, -guint port
, -GError **error
);guint port
, +GError **error
);
Create a new GUPnPContext with the specified Returns :main_context
, interface
and
port
.
@@ -132,12 +132,15 @@ Create a new
-main_context
 :Deprecated: 0.17.2: Always set to
+NULL
. If you want to use
-a different context, use g_main_context_push_thread_default()
.Deprecated: 0.17.2: Always set to
NULL
. If you
+want to use a different context, use g_main_context_push_thread_default()
. [allow-none]
+
-interface
 :The network interface to use, or
+NULL
to auto-detect.The network interface to use, or
NULL
to
+auto-detect. [allow-none]
+
@@ -145,12 +148,12 @@ a different context, use port
 :error
 :
-A location to store a GError, or NULL
+A location to store a GError, or
NULL
-A new GUPnPContext object, or
+NULL
on an errorA new GUPnPContext object, or
NULL
on an error
gupnp_context_get_host_ip
has been deprecated since version 0.12.7 and should not be used in newly-written code. The "host-ip" property has moved to the base class
-GSSDPClient so newer applications should use
-gssdp_client_get_host_ip instead.
Get the IP address we advertise ourselves as using. @@ -186,7 +189,7 @@ Get the IP address we advertise ourselves as using.
guint gupnp_context_get_port (GUPnPContext *context
);
+guint gupnp_context_get_port (GUPnPContext *context
);
Get the port that the SOAP server is running on.
@@ -257,7 +260,7 @@ this when finished. [void gupnp_context_set_subscription_timeout (+GUPnPContext *context
, -guint timeout
);
guint timeout
);
Sets the event subscription timeout to timeout
. Use 0 if you don't
want subscriptions to time out. Note that any client side subscriptions
@@ -281,7 +284,7 @@ will automatically be renewed.
guint gupnp_context_get_subscription_timeout +guint gupnp_context_get_subscription_timeout (GUPnPContext *context
);Get the event subscription timeout (in seconds), or 0 meaning there is no @@ -382,10 +385,10 @@ specified in the request's Accept-Language header.
@@ -446,7 +449,7 @@ Stop hosting the file or folder atgupnp_context_host_path_for_agent ()
-gboolean gupnp_context_host_path_for_agent (GUPnPContext *context
, +gboolean gupnp_context_host_path_for_agent (+GUPnPContext *context
,const char *local_path
,const char *server_path
, -GRegex *user_agent
);GRegex *user_agent
);Use this method to serve different local path to specific user-agent(s). The path
server_path
must already be hosted bycontext
. @@ -408,12 +411,12 @@ pathserver_path
must already be hosted-
user_agent
 :The user-agent as a GRegex. +The user-agent as a GRegex. Returns :
- +TRUE
on success,FALSE
otherwise.TRUE
on success,FALSE
otherwise.server_path
Property Details
@@ -459,7 +459,7 @@ administration.The
-"default-language"
property"default-language" gchar* : Read / Write / Construct+"default-language" gchar* : Read / Write / Construct
The content of the Content-Language header id the client sends Accept-Language and no language-specific pages to serve @@ -457,7 +460,7 @@ exist. The property defaults to 'en'.
@@ -435,7 +435,7 @@ Get the serial number of the device.The
-"port"
property"port" guint : Read / Write / Construct Only+"port" guint : Read / Write / Construct Only
The port to run on. Set to 0 if you don't care what port to run on.
@@ -482,7 +485,7 @@ The SoupSession object used by GUPnP.
@@ -413,7 +413,7 @@ Get a URL pointing to the device model's website.The
-"subscription-timeout"
property"subscription-timeout" guint : Read / Write / Construct Only+"subscription-timeout" guint : Read / Write / Construct Only
The preferred subscription timeout: the number of seconds after which subscriptions are renewed. Set to '0' if subscriptions diff --git a/doc/html/GUPnPContextManager.html b/doc/html/GUPnPContextManager.html index adbf182..40cb7a8 100644 --- a/doc/html/GUPnPContextManager.html +++ b/doc/html/GUPnPContextManager.html @@ -44,9 +44,9 @@
@@ -391,7 +391,7 @@ Get the model number of the device.Synopsis
struct GUPnPContextManager; -GUPnPContextManager * gupnp_context_manager_new (GMainContext *main_context
, -guint port
); -GUPnPContextManager * gupnp_context_manager_create (guint port
); +GUPnPContextManager * gupnp_context_manager_new (GMainContext *main_context
, +guint port
); +GUPnPContextManager * gupnp_context_manager_create (guint port
); void gupnp_context_manager_manage_control_point (GUPnPContextManager *manager
,GUPnPControlPoint *control_point
); @@ -58,22 +58,22 @@Properties
- "main-context" gpointer : Read / Write / Construct Only - "port" guint : Read / Write / Construct Only + "main-context" gpointer : Read / Write / Construct Only + "port" guint : Read / Write / Construct OnlySignals
- "context-available" :Run Last
- "context-unavailable" :Run First
+ "context-available" :Run Last
+ "context-unavailable" :Run First
@@ -97,8 +97,8 @@ functions below.@@ -369,7 +369,7 @@ Get the model name of the device.
@@ -347,7 +347,7 @@ Get the description of the device model.gupnp_context_manager_new ()
-GUPnPContextManager * gupnp_context_manager_new (+GMainContext *main_context
, -guint port
);GUPnPContextManager * gupnp_context_manager_new (GMainContext *main_context
, +guint port
);@@ -324,7 +324,7 @@ Get a URL pointing to the manufacturer's website.Warning
@@ -111,9 +111,9 @@ Same as
gupnp_context_manager_new
has been deprecated since version 0.17.2 and should not be used in newly-written code. Usegupnp_context_manager_create()
.main_context
 : -Deprecated: 0.17.2: NULL
. If you want to use +Deprecated: 0.17.2: NULL
. If you want to use a different main context use -g_main_context_push_thread_default()
instead. [allow-none] +g_main_context_push_thread_default()
instead. [allow-none]@@ -131,7 +131,7 @@ a different main context use
gupnp_context_manager_create ()
-GUPnPContextManager * gupnp_context_manager_create (+guint port
);GUPnPContextManager * gupnp_context_manager_create (guint port
);Factory-method to create a new GUPnPContextManager. The final type of the GUPnPContextManager depends on the compile-time selection or - in case of @@ -214,13 +214,13 @@ usually want to call this function from
Property Details
The
-"main-context"
property"main-context" gpointer : Read / Write / Construct Only+"main-context" gpointer : Read / Write / Construct Only
GMainContext to pass to created GUPnPContext objects.
The
-"port"
property"port" guint : Read / Write / Construct Only+"port" guint : Read / Write / Construct Only
Port the contexts listen on, or 0 if you don't care what port is used by GUPnPContext objects created by this object. @@ -234,7 +234,7 @@ port is used by
The
"context-available"
signalvoid user_function (GUPnPContextManager *context_manager, GUPnPContext *context, - gpointer user_data) :+ gpointer user_data) :Run Last
Run Last
Signals the availability of new GUPnPContext.
@@ -262,7 +262,7 @@ Signals the availability of newThe
"context-unavailable"
signalvoid user_function (GUPnPContextManager *context_manager, GUPnPContext *context, - gpointer user_data) :+ gpointer user_data) :Run First
Run First
Signals the unavailability of a GUPnPContext.
diff --git a/doc/html/GUPnPControlPoint.html b/doc/html/GUPnPControlPoint.html index f3aa9f1..a2d9fe2 100644 --- a/doc/html/GUPnPControlPoint.html +++ b/doc/html/GUPnPControlPoint.html @@ -52,17 +52,17 @@ GUPnPResourceFactory * gupnp_control_point_get_resource_factory (GUPnPControlPoint *control_point
); GUPnPContext * gupnp_control_point_get_context (GUPnPControlPoint *control_point
); -const GList * gupnp_control_point_list_device_proxies +const GList * gupnp_control_point_list_device_proxies (GUPnPControlPoint *control_point
); -const GList * gupnp_control_point_list_service_proxies +const GList * gupnp_control_point_list_service_proxies (GUPnPControlPoint *control_point
);@@ -75,17 +75,17 @@ constObject Hierarchy
- GObject - +----GSSDPResourceBrowser + GObject + +----GSSDPResourceBrowser +----GUPnPControlPointSignals
- "device-proxy-available" :Run Last
- "device-proxy-unavailable" :Run Last
- "service-proxy-available" :Run Last
- "service-proxy-unavailable" :Run Last
+ "device-proxy-available" :Run Last
+ "device-proxy-unavailable" :Run Last
+ "service-proxy-available" :Run Last
+ "service-proxy-unavailable" :Run Last
Description
GUPnPControlPoint handles device and service discovery. After creating -a control point and activating it using
gssdp_resource_browser_set_active()
, +a control point and activating it usinggssdp_resource_browser_set_active()
, the ::device-proxy-available, ::service-proxy-available, ::device-proxy-unavailable and ::service-proxy-unavailable signals will be emitted whenever the availability of a device or service matching @@ -223,10 +223,10 @@ Get the
gupnp_control_point_list_device_proxies ()
-const GList * gupnp_control_point_list_device_proxies +const GList * gupnp_control_point_list_device_proxies (GUPnPControlPoint *control_point
);-Get the GList of discovered GUPnPDeviceProxy objects. Do not free the list +Get the GList of discovered GUPnPDeviceProxy objects. Do not free the list nor its elements.
@@ -301,7 +301,7 @@ Get the manufacturer of the device.@@ -239,7 +239,7 @@ nor its elements.
@@ -249,10 +249,10 @@ nor its elements. - Returns :
a GList of + a GList of GUPnPDeviceProxy objects. [element-type GUPnP.DeviceProxy][transfer none]
gupnp_control_point_list_service_proxies ()
-const GList * gupnp_control_point_list_service_proxies +const GList * gupnp_control_point_list_service_proxies (GUPnPControlPoint *control_point
);-Get the GList of discovered GUPnPServiceProxy objects. Do not free the +Get the GList of discovered GUPnPServiceProxy objects. Do not free the list nor its elements.
@@ -279,7 +279,7 @@ Get the friendly name of the device.@@ -265,7 +265,7 @@ list nor its elements.
@@ -289,7 +289,7 @@ The resource factory to use. Set to NULL for default factory. - Returns :
a GList + a GList of GUPnPServiceProxy objects. [element-type GUPnP.ServiceProxy][transfer none] The
"device-proxy-available"
signalvoid user_function (GUPnPControlPoint *control_point, GUPnPDeviceProxy *proxy, - gpointer user_data) :+ gpointer user_data) :Run Last
Run Last
The ::device-proxy-available signal is emitted whenever a new device has become available. @@ -318,7 +318,7 @@ device has become available.
The
"device-proxy-unavailable"
signalvoid user_function (GUPnPControlPoint *control_point, GUPnPDeviceProxy *proxy, - gpointer user_data) :+ gpointer user_data) :Run Last
Run Last
The ::device-proxy-unavailable signal is emitted whenever a device is not available any more. @@ -347,7 +347,7 @@ device is not available any more.
The
"service-proxy-available"
signalvoid user_function (GUPnPControlPoint *control_point, GUPnPServiceProxy *proxy, - gpointer user_data) :+ gpointer user_data) :Run Last
Run Last
The ::service-proxy-available signal is emitted whenever a new service has become available. @@ -376,7 +376,7 @@ service has become available.
The
"service-proxy-unavailable"
signalvoid user_function (GUPnPControlPoint *control_point, GUPnPServiceProxy *proxy, - gpointer user_data) :+ gpointer user_data) :Run Last
Run Last
The ::service-proxy-unavailable signal is emitted whenever a service is not available any more. diff --git a/doc/html/GUPnPDevice.html b/doc/html/GUPnPDevice.html index 8c7b8fc..ec1c3e7 100644 --- a/doc/html/GUPnPDevice.html +++ b/doc/html/GUPnPDevice.html @@ -47,7 +47,7 @@
Object Hierarchy
- GObject + GObject +----GUPnPDeviceInfo +----GUPnPDevice +----GUPnPRootDevice diff --git a/doc/html/GUPnPDeviceInfo.html b/doc/html/GUPnPDeviceInfo.html index 9d87358..a8caa66 100644 --- a/doc/html/GUPnPDeviceInfo.html +++ b/doc/html/GUPnPDeviceInfo.html @@ -67,22 +67,22 @@ const char *int requested_depth
,int requested_width
,int requested_height
, -gboolean prefer_bigger
, +gboolean prefer_bigger
,char **mime_type
,int *depth
,int *width
,int *height
); -GList * gupnp_device_info_list_dlna_capabilities +GList * gupnp_device_info_list_dlna_capabilities (GUPnPDeviceInfo *info
); char * gupnp_device_info_get_description_value (GUPnPDeviceInfo *info
,const char *element
); -GList * gupnp_device_info_list_devices (GUPnPDeviceInfo *info
); -GList * gupnp_device_info_list_device_types (GUPnPDeviceInfo *info
); +GList * gupnp_device_info_list_devices (GUPnPDeviceInfo *info
); +GList * gupnp_device_info_list_device_types (GUPnPDeviceInfo *info
); GUPnPDeviceInfo * gupnp_device_info_get_device (GUPnPDeviceInfo *info
,const char *type
); -GList * gupnp_device_info_list_services (GUPnPDeviceInfo *info
); -GList * gupnp_device_info_list_service_types +GList * gupnp_device_info_list_services (GUPnPDeviceInfo *info
); +GList * gupnp_device_info_list_service_types (GUPnPDeviceInfo *info
); GUPnPServiceInfo * gupnp_device_info_get_service (GUPnPDeviceInfo *info
,const char *type
); @@ -91,7 +91,7 @@ const char *Object Hierarchy
- GObject + GObject +----GUPnPDeviceInfo +----GUPnPDevice +----GUPnPDeviceProxy @@ -101,13 +101,13 @@ const char *Properties
"context" GUPnPContext* : Read / Write / Construct Only - "device-type" gchar* : Read / Write / Construct Only + "device-type" gchar* : Read / Write / Construct Only "document" GUPnPXMLDoc* : Write / Construct Only - "element" gpointer : Write / Construct Only - "location" gchar* : Read / Write / Construct Only + "element" gpointer : Write / Construct Only + "location" gchar* : Read / Write / Construct Only "resource-factory" GUPnPResourceFactory* : Read / Write / Construct Only - "udn" gchar* : Read / Write / Construct Only - "url-base" gpointer : Read / Write / Construct Only + "udn" gchar* : Read / Write / Construct Only + "url-base" SoupURI* : Read / Write / Construct Only@@ -257,7 +257,7 @@ Get the UPnP device type.- Returns :
A constant string, or +NULL
.A constant string, or NULL
.- Returns :
A string, or +NULL
.g_free()
after use.A string, or NULL
.g_free()
after use.- Returns :
A string, or +NULL
.g_free()
after use.A string, or NULL
.g_free()
after use.- Returns :
A string, or +NULL
.g_free()
after use.A string, or NULL
.g_free()
after use.- Returns :
A string, or +NULL
.g_free()
after use.A string, or NULL
.g_free()
after use.- Returns :
A string, or +NULL
.g_free()
after use.A string, or NULL
.g_free()
after use.- Returns :
A string, or +NULL
.g_free()
after use.A string, or NULL
.g_free()
after use.- Returns :
A string, or +NULL
.g_free()
after use.A string, or NULL
.g_free()
after use.- Returns :
A string, or +NULL
.g_free()
after use.A string, or NULL
.g_free()
after use.- Returns :
A string, or +NULL
.g_free()
after use.A string, or NULL
.g_free()
after use.
Returns :
NULL
. g_free()
after use.NULL
. g_free()
after use.int requested_depth
,
int requested_width
,
int requested_height
,
- gboolean prefer_bigger
,
+ gboolean prefer_bigger
,
char **mime_type
,
int *depth
,
int *width
,
int *height
);
Get a URL pointing to the icon most closely matching the
-given criteria, or NULL
. If requested_mime_type
is set, only icons with
+given criteria, or NULL
. If requested_mime_type
is set, only icons with
this mime type will be returned. If requested_depth
is set, only icons with
this or lower depth will be returned. If requested_width
and/or
requested_height
are set, only icons that are this size or smaller are
@@ -519,7 +519,7 @@ will be returned. The returned strings should be freed.
requested_mime_type
 :
NULL
for any. [allow-none][transfer none]
+format, or NULL
for any. [allow-none][transfer none]
prefer_bigger
 :
TRUE
if a bigger, rather than a smaller icon should be
+TRUE
if a bigger, rather than a smaller icon should be
returned if no exact match could be foundmime_type
 :
NULL
. The returned string should be freed after
+of the returned icon, or NULL
. The returned string should be freed after
use. [out][allow-none]
depth
 :
NULL
+returned icon, or NULL
width
 :
NULL
+returned icon, or NULL
height
 :
NULL
+returned icon, or NULL
Returns :
NULL
. g_free()
after use. [transfer full]
+NULL
. g_free()
after use. [transfer full]
GList * gupnp_device_info_list_dlna_capabilities +GList * gupnp_device_info_list_dlna_capabilities (GUPnPDeviceInfo *info
);-Get a GList of strings that represent the device capabilities as announced +Get a GList of strings that represent the device capabilities as announced in the device description file using the <dlna:X_DLNACAP> element.
@@ -326,15 +326,15 @@ out parameter type, and out parameter value location
@@ -456,7 +456,7 @@ that line up withgupnp_service_proxy_send_action_hash ()
-gboolean gupnp_service_proxy_send_action_hash +gboolean gupnp_service_proxy_send_action_hash (+GUPnPServiceProxy *proxy
,const char *action
, -GError **error
, -GHashTable *in_hash
, -GHashTable *out_hash
);GError **error
, +GHashTable *in_hash
, +GHashTable *out_hash
);See
gupnp_service_proxy_send_action()
; this version takes a pair of -GHashTables for runtime determined parameter lists. +GHashTables for runtime determined parameter lists.@@ -376,15 +376,15 @@ of out parameter name and initialized
@@ -350,25 +350,25 @@ See error
 : -The location where to store any error, or NULL
+The location where to store any error, or NULL
-
in_hash
 :A GHashTable of in -parameter name and GValue pairs. [element-type utf8 GValue][transfer none] + A GHashTable of in +parameter name and GValue pairs. [element-type utf8 GValue][transfer none] -
out_hash
 :A GHashTable -of out parameter name and initialized GValue pairs. [inout][element-type utf8 GValue][transfer full] + A GHashTable +of out parameter name and initialized GValue pairs. [inout][element-type utf8 GValue][transfer full] Returns :
- +TRUE
if sending the action was succesful.TRUE
if sending the action was succesful.gupnp_service_proxy_send_action_list ()
-gboolean gupnp_service_proxy_send_action_list +gboolean gupnp_service_proxy_send_action_list (+GUPnPServiceProxy *proxy
,const char *action
, -GError **error
, -GList *in_names
, -GList *in_values
, -GList *out_names
, -GList *out_types
, -GList **out_values
);GError **error
, +GList *in_names
, +GList *in_values
, +GList *out_names
, +GList *out_types
, +GList **out_values
);The synchronous variant of gupnp_service_proxy_begin_action_list and gupnp_service_proxy_end_action_list. @@ -403,48 +403,48 @@ The synchronous variant of
-error
 :The location where to store any error, or NULL
+The location where to store any error, or NULL
in_names
 :-GList of 'in' parameter +GList of 'in' parameter names (as strings). [element-type utf8][transfer none]
in_values
 :-GList of values (as -GValue) that line up with in_names
. [element-type GValue][transfer none] +GList of values (as +GValue) that line up within_names
. [element-type GValue][transfer none]
out_names
 :-GList of 'out' parameter +GList of 'out' parameter names (as strings). [element-type utf8][transfer none]
out_types
 :-GList of types (as GType) +GList of types (as GType) that line up with out_names
. [element-type GType][transfer none]
out_values
 :-GList of values -(as GValue) that line up with out_names
andout_types
. [element-type GValue][transfer full][out] +GList of values +(as GValue) that line up without_names
andout_types
. [element-type GValue][transfer full][out]Returns :
- +TRUE
if sending the action was succesful.TRUE
if sending the action was succesful.out_names
.GUPnPServiceProxy *proxy
,const char *action
,GUPnPServiceProxyActionCallback callback
, -gpointer user_data
, +gpointer user_data
,...
);
Sends action
See
-See Returns :
A variant of gupnp_service_proxy_begin_action that takes lists of
in-parameter names, types and values.
@@ -626,15 +627,15 @@ in-parameter names, types and values.
Retrieves the result of Returns :
See Returns :
-See Returns :
A variant of gupnp_service_proxy_end_action that takes lists of
out-parameter names, types and place-holders for values. The returned list
-in
-Return value :
Sets up Returns :
Cancels the variable change notification for Returns :
(Un)subscribes to this service.
Returns if we are subscribed to this service.
Returns :
Whether we are subscribed to this service.
Emitted whenever the subscription to this service has been lost due
to an error condition.
@@ -1032,8 +1033,9 @@ to an error condition.
Returns :
Create a new GUPnPXMLDoc for the XML document at Returns : Generics and defining elements of containers and arrays. The callback is valid only during the call to the method. Free data after the code is done. The callback is valid only during the call to the method. Override the parsed C type with given type
This chapter explains how to write an application which fetches the
external IP address from an UPnP-compliant modem. To do this a
@@ -41,7 +41,7 @@
First, we initialize GUPnP and create a control point targeting the
service type. Then we connect a signal handler so that we are notified
@@ -102,7 +102,7 @@ main (int argc, char **argv)
Now we have an application which searches for the service we specified and
calls
It is possible to get change notifications for the service state variables
that have attribute
Using gupnp_service_proxy_send_action() and gupnp_service_proxy_add_notify ()
can become tedious, because of the requirement to specify the types and deal
diff --git a/doc/html/gupnp-Error-codes.html b/doc/html/gupnp-Error-codes.html
index 305f420..a565d32 100644
--- a/doc/html/gupnp-Error-codes.html
+++ b/doc/html/gupnp-Error-codes.html
@@ -57,13 +57,13 @@ enum #define GUPNP_SERVER_ERROR (gupnp_server_error_quark ())
-The GQuark uniquely used by GUPnP's server errors.
+The GQuark uniquely used by GUPnP's server errors.
Returns :
-The GQuark uniquely used by GUPnP's eventing errors.
+The GQuark uniquely used by GUPnP's eventing errors.
Returns :
-The GQuark uniquely used by GUPnP's control errors.
+The GQuark uniquely used by GUPnP's control errors.
Returns :
-The GQuark uniquely used by GUPnP XML processing errors.
+The GQuark uniquely used by GUPnP XML processing errors.
Returns :
gupnp-binding-tool takes a SCPD file and generates convenience C functions
which call the actual GUPnP functions. The client-side bindings can be seen
@@ -49,7 +49,7 @@
As an example, this action:
The corresponding server bindings for the same UPnP action
(DeletePortMapping) look like this:
diff --git a/doc/html/gupnp-gupnp-service-introspection.html b/doc/html/gupnp-gupnp-service-introspection.html
index ab704fa..f791ba3 100644
--- a/doc/html/gupnp-gupnp-service-introspection.html
+++ b/doc/html/gupnp-gupnp-service-introspection.html
@@ -46,33 +46,33 @@
GUPnPServiceActionInfo;
GUPnPServiceStateVariableInfo;
struct GUPnPServiceIntrospection;
-const GList * gupnp_service_introspection_list_action_names
+const GList * gupnp_service_introspection_list_action_names
( gboolean GList * gboolean gboolean GType GValue GValue GValue GValue GList *
Returns a GList of names of all the actions in this service.
@@ -281,7 +283,7 @@ Returns a GList of names of all the actions in this service.
Returns :
-Returns a GList of all the actions (of type GUPnPServiceActionInfo) in
+Returns a GList of all the actions (of type GUPnPServiceActionInfo) in
this service.
Returns :
Returns the action by the name Returns :
-Returns a GList of names of all the state variables in this service.
+Returns a GList of names of all the state variables in this service.
Returns a GList of all the state variables (of type
@@ -387,7 +389,7 @@ Returns a GList of all the state variables (of type
Returns :
Returns the state variable by the name Returns :
The scpd of the device description file.
GUPnP Reference Manual Version 0.18.0
+ Version 0.19.1
Copyright © 2007, 2008, 2009 OpenedHand Ltd, Nokia Corporation
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free
Documentation License, Version 1.1 or any later
diff --git a/doc/html/index.sgml b/doc/html/index.sgml
index 1a0b29f..3dc7333 100644
--- a/doc/html/index.sgml
+++ b/doc/html/index.sgml
@@ -326,5 +326,6 @@
This chapter explains how to implement a UPnP service using GUPnP. For
this example we will create a virtual UPnP-enabled light bulb.
@@ -32,20 +32,21 @@
Before any code can be written, the device and services that it implement
need to be described in XML. Although this can be frustrating, if you are
- implementing a standardised service (see http://upnp.org/standardizeddcps/ for the list of standard devices
- and services) then the service description is already written for you and
- the device description is trivial. UPnP has standardised Lighting
+ implementing a standardised service (see http://upnp.org/sdcps-and-certification/standards/sdcps/ for the
+ list of standard devices and services) then the service description is
+ already written for you and the device description is trivial. UPnP has
+ standardised Lighting
Controls, so we'll be using the device and service types defined
there.
The first step is to write the device description
file. This is a short XML document which describes the device and what
- services it provides (for more details see the UPnP
+ services it provides (for more details see the UPnP
Device Architecture specification, section 2.1). We'll be using
the
Because we are using a standard service we can use the service description
from the specification. This is the
For the full specification of the service definition file, including a
complete list of valid
Before starting to implement the device, some boilerplate code is needed
to initialise GUPnP. GLib types and threading needs to be initialised,
@@ -246,7 +247,7 @@ gupnp_root_device_set_available (dev, TRUE);
To implement a service we first fetch the #GUPnPService from the root
device using gupnp_device_info_get_service() (#GUPnPRootDevice is a
@@ -355,7 +356,7 @@ g_signal_connect (service, "query-variable::Status", G_CALLBACK (query_status_cb
Using service-specific wrappers can simplify the implementation of a service.
Wrappers can be generated with gupnp-binding-tool(1)
diff --git a/examples/Makefile.in b/examples/Makefile.in
index 9fa4f5b..87550b9 100644
--- a/examples/Makefile.in
+++ b/examples/Makefile.in
@@ -1,4 +1,4 @@
-# Makefile.in generated by automake 1.11.3 from Makefile.am.
+# Makefile.in generated by automake 1.11.6 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
@@ -16,6 +16,23 @@
@SET_MAKE@
VPATH = @srcdir@
+am__make_dryrun = \
+ { \
+ am__dry=no; \
+ case $$MAKEFLAGS in \
+ *\\[\ \ ]*) \
+ echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \
+ | grep '^AM OK$$' >/dev/null || am__dry=yes;; \
+ *) \
+ for am__flg in $$MAKEFLAGS; do \
+ case $$am__flg in \
+ *=*|--*) ;; \
+ *n*) am__dry=yes; break;; \
+ esac; \
+ done;; \
+ esac; \
+ test $$am__dry = yes; \
+ }
pkgdatadir = $(datadir)/@PACKAGE@
pkgincludedir = $(includedir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
@@ -43,7 +60,7 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \
$(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \
$(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \
$(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \
- $(top_srcdir)/configure.ac
+ $(top_srcdir)/m4/vapigen.m4 $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
mkinstalldirs = $(install_sh) -d
@@ -96,6 +113,11 @@ am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@)
am__v_GEN_0 = @echo " GEN " $@;
SOURCES = $(light_client_SOURCES) $(light_server_SOURCES)
DIST_SOURCES = $(light_client_SOURCES) $(light_server_SOURCES)
+am__can_run_installinfo = \
+ case $$AM_UPDATE_INFO_DIR in \
+ n|no|NO) false;; \
+ *) (install-info --version) >/dev/null 2>&1;; \
+ esac
ETAGS = etags
CTAGS = ctags
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
@@ -191,6 +213,7 @@ SET_MAKE = @SET_MAKE@
SHELL = @SHELL@
STRIP = @STRIP@
USE_NETLINK = @USE_NETLINK@
+VAPIGEN = @VAPIGEN@
VERSION = @VERSION@
abs_builddir = @abs_builddir@
abs_srcdir = @abs_srcdir@
diff --git a/gupnp-1.0-uninstalled.pc.in b/gupnp-1.0-uninstalled.pc.in
index 601e478..40e75ca 100644
--- a/gupnp-1.0-uninstalled.pc.in
+++ b/gupnp-1.0-uninstalled.pc.in
@@ -8,5 +8,4 @@ Description: GObject-based UPnP library
Version: @VERSION@
Libs: ${libdir}/libgupnp-1.0.la
Cflags: -I${includedir}
-Requires: gssdp-1.0 libxml-2.0 libsoup-2.4
-Requires.Private: uuid gmodule-2.0
+Requires.private: gssdp-1.0 libxml-2.0 libsoup-2.4
diff --git a/gupnp-1.0.pc.in b/gupnp-1.0.pc.in
index d4acdd2..d2612b4 100644
--- a/gupnp-1.0.pc.in
+++ b/gupnp-1.0.pc.in
@@ -8,5 +8,4 @@ Description: GObject-based UPnP library
Version: @VERSION@
Libs: -L${libdir} -lgupnp-1.0
Cflags: -I${includedir}/gupnp-1.0
-Requires: gssdp-1.0 libxml-2.0 libsoup-2.4
-Requires.Private: uuid gmodule-2.0
+Requires.private: gssdp-1.0 libxml-2.0 libsoup-2.4
diff --git a/libgupnp/Makefile.am b/libgupnp/Makefile.am
index 46a37b4..864e450 100644
--- a/libgupnp/Makefile.am
+++ b/libgupnp/Makefile.am
@@ -117,7 +117,8 @@ INTROSPECTION_GIRS =
INTROSPECTION_SCANNER_ARGS = --warn-all \
--symbol-prefix=gupnp \
--identifier-prefix=GUPnP \
- --add-include-path=$(top_srcdir)
+ --add-include-path=$(top_srcdir) \
+ --pkg-export=gupnp-1.0
INTROSPECTION_COMPILER_ARGS = --includedir=$(top_srcdir)
if HAVE_INTROSPECTION
diff --git a/libgupnp/Makefile.in b/libgupnp/Makefile.in
index 2ea4678..04c2da9 100644
--- a/libgupnp/Makefile.in
+++ b/libgupnp/Makefile.in
@@ -1,4 +1,4 @@
-# Makefile.in generated by automake 1.11.3 from Makefile.am.
+# Makefile.in generated by automake 1.11.6 from Makefile.am.
# @configure_input@
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
@@ -18,6 +18,23 @@
VPATH = @srcdir@
+am__make_dryrun = \
+ { \
+ am__dry=no; \
+ case $$MAKEFLAGS in \
+ *\\[\ \ ]*) \
+ echo 'am--echo: ; @echo "AM" OK' | $(MAKE) -f - 2>/dev/null \
+ | grep '^AM OK$$' >/dev/null || am__dry=yes;; \
+ *) \
+ for am__flg in $$MAKEFLAGS; do \
+ case $$am__flg in \
+ *=*|--*) ;; \
+ *n*) am__dry=yes; break;; \
+ esac; \
+ done;; \
+ esac; \
+ test $$am__dry = yes; \
+ }
pkgdatadir = $(datadir)/@PACKAGE@
pkgincludedir = $(includedir)/@PACKAGE@
pkglibdir = $(libdir)/@PACKAGE@
@@ -56,7 +73,7 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/gtk-doc.m4 \
$(top_srcdir)/m4/introspection.m4 $(top_srcdir)/m4/libtool.m4 \
$(top_srcdir)/m4/ltoptions.m4 $(top_srcdir)/m4/ltsugar.m4 \
$(top_srcdir)/m4/ltversion.m4 $(top_srcdir)/m4/lt~obsolete.m4 \
- $(top_srcdir)/configure.ac
+ $(top_srcdir)/m4/vapigen.m4 $(top_srcdir)/configure.ac
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
$(ACLOCAL_M4)
mkinstalldirs = $(install_sh) -d
@@ -169,6 +186,11 @@ am__v_GEN_ = $(am__v_GEN_@AM_DEFAULT_V@)
am__v_GEN_0 = @echo " GEN " $@;
SOURCES = $(libgupnp_1_0_la_SOURCES)
DIST_SOURCES = $(am__libgupnp_1_0_la_SOURCES_DIST)
+am__can_run_installinfo = \
+ case $$AM_UPDATE_INFO_DIR in \
+ n|no|NO) false;; \
+ *) (install-info --version) >/dev/null 2>&1;; \
+ esac
DATA = $(gir_DATA) $(typelib_DATA)
HEADERS = $(libgupnpinc_HEADERS)
ETAGS = etags
@@ -266,6 +288,7 @@ SET_MAKE = @SET_MAKE@
SHELL = @SHELL@
STRIP = @STRIP@
USE_NETLINK = @USE_NETLINK@
+VAPIGEN = @VAPIGEN@
VERSION = @VERSION@
abs_builddir = @abs_builddir@
abs_srcdir = @abs_srcdir@
@@ -409,7 +432,8 @@ INTROSPECTION_GIRS = $(am__append_4)
INTROSPECTION_SCANNER_ARGS = --warn-all \
--symbol-prefix=gupnp \
--identifier-prefix=GUPnP \
- --add-include-path=$(top_srcdir)
+ --add-include-path=$(top_srcdir) \
+ --pkg-export=gupnp-1.0
INTROSPECTION_COMPILER_ARGS = --includedir=$(top_srcdir)
@HAVE_INTROSPECTION_TRUE@GUPnP_1_0_gir_INCLUDES = libxml2-2.0 GObject-2.0 Soup-2.4 GSSDP-1.0
@@ -462,7 +486,6 @@ $(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps)
$(am__aclocal_m4_deps):
install-libLTLIBRARIES: $(lib_LTLIBRARIES)
@$(NORMAL_INSTALL)
- test -z "$(libdir)" || $(MKDIR_P) "$(DESTDIR)$(libdir)"
@list='$(lib_LTLIBRARIES)'; test -n "$(libdir)" || list=; \
list2=; for p in $$list; do \
if test -f $$p; then \
@@ -470,6 +493,8 @@ install-libLTLIBRARIES: $(lib_LTLIBRARIES)
else :; fi; \
done; \
test -z "$$list2" || { \
+ echo " $(MKDIR_P) '$(DESTDIR)$(libdir)'"; \
+ $(MKDIR_P) "$(DESTDIR)$(libdir)" || exit 1; \
echo " $(LIBTOOL) $(AM_LIBTOOLFLAGS) $(LIBTOOLFLAGS) --mode=install $(INSTALL) $(INSTALL_STRIP_FLAG) $$list2 '$(DESTDIR)$(libdir)'"; \
$(LIBTOOL) $(AM_LIBTOOLFLAGS) $(LIBTOOLFLAGS) --mode=install $(INSTALL) $(INSTALL_STRIP_FLAG) $$list2 "$(DESTDIR)$(libdir)"; \
}
@@ -553,8 +578,11 @@ clean-libtool:
-rm -rf .libs _libs
install-girDATA: $(gir_DATA)
@$(NORMAL_INSTALL)
- test -z "$(girdir)" || $(MKDIR_P) "$(DESTDIR)$(girdir)"
@list='$(gir_DATA)'; test -n "$(girdir)" || list=; \
+ if test -n "$$list"; then \
+ echo " $(MKDIR_P) '$(DESTDIR)$(girdir)'"; \
+ $(MKDIR_P) "$(DESTDIR)$(girdir)" || exit 1; \
+ fi; \
for p in $$list; do \
if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
echo "$$d$$p"; \
@@ -571,8 +599,11 @@ uninstall-girDATA:
dir='$(DESTDIR)$(girdir)'; $(am__uninstall_files_from_dir)
install-typelibDATA: $(typelib_DATA)
@$(NORMAL_INSTALL)
- test -z "$(typelibdir)" || $(MKDIR_P) "$(DESTDIR)$(typelibdir)"
@list='$(typelib_DATA)'; test -n "$(typelibdir)" || list=; \
+ if test -n "$$list"; then \
+ echo " $(MKDIR_P) '$(DESTDIR)$(typelibdir)'"; \
+ $(MKDIR_P) "$(DESTDIR)$(typelibdir)" || exit 1; \
+ fi; \
for p in $$list; do \
if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
echo "$$d$$p"; \
@@ -589,8 +620,11 @@ uninstall-typelibDATA:
dir='$(DESTDIR)$(typelibdir)'; $(am__uninstall_files_from_dir)
install-libgupnpincHEADERS: $(libgupnpinc_HEADERS)
@$(NORMAL_INSTALL)
- test -z "$(libgupnpincdir)" || $(MKDIR_P) "$(DESTDIR)$(libgupnpincdir)"
@list='$(libgupnpinc_HEADERS)'; test -n "$(libgupnpincdir)" || list=; \
+ if test -n "$$list"; then \
+ echo " $(MKDIR_P) '$(DESTDIR)$(libgupnpincdir)'"; \
+ $(MKDIR_P) "$(DESTDIR)$(libgupnpincdir)" || exit 1; \
+ fi; \
for p in $$list; do \
if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
echo "$$d$$p"; \
diff --git a/libgupnp/gupnp-context-manager.c b/libgupnp/gupnp-context-manager.c
index dbac15d..2888a1b 100644
--- a/libgupnp/gupnp-context-manager.c
+++ b/libgupnp/gupnp-context-manager.c
@@ -415,3 +415,17 @@ gupnp_context_manager_manage_root_device (GUPnPContextManager *manager,
g_object_ref (root_device));
}
+/**
+ * gupnp_context_manager_get_port:
+ * @manager: A #GUPnPContextManager
+ *
+ * Get the network port associated with this context manager.
+ * Returns: The network port asssociated with this context manager.
+ */
+guint
+gupnp_context_manager_get_port (GUPnPContextManager *manager)
+{
+ g_return_if_fail (GUPNP_IS_CONTEXT_MANAGER (manager));
+
+ return manager->priv->port;
+}
diff --git a/libgupnp/gupnp-context-manager.h b/libgupnp/gupnp-context-manager.h
index 2782898..9fa2154 100644
--- a/libgupnp/gupnp-context-manager.h
+++ b/libgupnp/gupnp-context-manager.h
@@ -99,6 +99,8 @@ gupnp_context_manager_manage_root_device
(GUPnPContextManager *manager,
GUPnPRootDevice *root_device);
+guint
+gupnp_context_manager_get_port (GUPnPContextManager *manager);
G_END_DECLS
#endif /* __GUPNP_CONTEXT_MANAGER_H__ */
diff --git a/libgupnp/gupnp-context.c b/libgupnp/gupnp-context.c
index d62a17a..114b1b3 100644
--- a/libgupnp/gupnp-context.c
+++ b/libgupnp/gupnp-context.c
@@ -545,9 +545,10 @@ _gupnp_context_get_server_url (GUPnPContext *context)
/**
* gupnp_context_new:
- * @main_context: Deprecated: 0.17.2: Always set to %NULL. If you want to use
- * a different context, use g_main_context_push_thread_default().
- * @interface: The network interface to use, or %NULL to auto-detect.
+ * @main_context: (allow-none): Deprecated: 0.17.2: Always set to %NULL. If you
+ * want to use a different context, use g_main_context_push_thread_default().
+ * @interface: (allow-none): The network interface to use, or %NULL to
+ * auto-detect.
* @port: Port to run on, or 0 if you don't care what port is used.
* @error: A location to store a #GError, or %NULL
*
diff --git a/libgupnp/gupnp-device-info.c b/libgupnp/gupnp-device-info.c
index a2f4cd5..4f6fe2b 100644
--- a/libgupnp/gupnp-device-info.c
+++ b/libgupnp/gupnp-device-info.c
@@ -101,11 +101,7 @@ gupnp_device_info_set_property (GObject *object,
info->priv->device_type = g_value_dup_string (value);
break;
case PROP_URL_BASE:
- info->priv->url_base = g_value_get_pointer (value);
- if (info->priv->url_base)
- info->priv->url_base =
- soup_uri_copy (info->priv->url_base);
-
+ info->priv->url_base = g_value_dup_boxed (value);
break;
case PROP_DOCUMENT:
info->priv->doc = g_value_dup_object (value);
@@ -151,8 +147,7 @@ gupnp_device_info_get_property (GObject *object,
gupnp_device_info_get_device_type (info));
break;
case PROP_URL_BASE:
- g_value_set_pointer (value,
- info->priv->url_base);
+ g_value_set_boxed (value, info->priv->url_base);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
@@ -314,14 +309,15 @@ gupnp_device_info_class_init (GUPnPDeviceInfoClass *klass)
g_object_class_install_property
(object_class,
PROP_URL_BASE,
- g_param_spec_pointer ("url-base",
- "URL base",
- "The URL base",
- G_PARAM_READWRITE |
- G_PARAM_CONSTRUCT_ONLY |
- G_PARAM_STATIC_NAME |
- G_PARAM_STATIC_NICK |
- G_PARAM_STATIC_BLURB));
+ g_param_spec_boxed ("url-base",
+ "URL base",
+ "The URL base",
+ SOUP_TYPE_URI,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_NAME |
+ G_PARAM_STATIC_NICK |
+ G_PARAM_STATIC_BLURB));
/**
* GUPnPDeviceInfo:document:
@@ -1109,7 +1105,7 @@ gupnp_device_info_list_device_types (GUPnPDeviceInfo *info)
* this function a new object is created. The application must cache any used
* devices if it wishes to keep them around and re-use them.
*
- * Returns: (transfer full): A new #GUPnPDeviceInfo.
+ * Returns: (transfer full)(allow-none): A new #GUPnPDeviceInfo.
**/
GUPnPDeviceInfo *
gupnp_device_info_get_device (GUPnPDeviceInfo *info,
diff --git a/libgupnp/gupnp-service-info.c b/libgupnp/gupnp-service-info.c
index fd3f785..8849a67 100644
--- a/libgupnp/gupnp-service-info.c
+++ b/libgupnp/gupnp-service-info.c
@@ -118,11 +118,7 @@ gupnp_service_info_set_property (GObject *object,
info->priv->service_type = g_value_dup_string (value);
break;
case PROP_URL_BASE:
- info->priv->url_base = g_value_get_pointer (value);
- if (info->priv->url_base)
- info->priv->url_base =
- soup_uri_copy (info->priv->url_base);
-
+ info->priv->url_base = g_value_dup_boxed (value);
break;
case PROP_DOCUMENT:
info->priv->doc = g_value_dup_object (value);
@@ -164,8 +160,8 @@ gupnp_service_info_get_property (GObject *object,
gupnp_service_info_get_service_type (info));
break;
case PROP_URL_BASE:
- g_value_set_pointer (value,
- info->priv->url_base);
+ g_value_set_boxed (value,
+ info->priv->url_base);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
@@ -326,14 +322,15 @@ gupnp_service_info_class_init (GUPnPServiceInfoClass *klass)
g_object_class_install_property
(object_class,
PROP_URL_BASE,
- g_param_spec_pointer ("url-base",
- "URL base",
- "The URL base",
- G_PARAM_READWRITE |
- G_PARAM_CONSTRUCT_ONLY |
- G_PARAM_STATIC_NAME |
- G_PARAM_STATIC_NICK |
- G_PARAM_STATIC_BLURB));
+ g_param_spec_boxed ("url-base",
+ "URL base",
+ "The URL base",
+ SOUP_TYPE_URI,
+ G_PARAM_READWRITE |
+ G_PARAM_CONSTRUCT_ONLY |
+ G_PARAM_STATIC_NAME |
+ G_PARAM_STATIC_NICK |
+ G_PARAM_STATIC_BLURB));
/**
* GUPnPServiceInfo:document:
diff --git a/libgupnp/gupnp-service-introspection.c b/libgupnp/gupnp-service-introspection.c
index 2eb3bc3..e3335f3 100644
--- a/libgupnp/gupnp-service-introspection.c
+++ b/libgupnp/gupnp-service-introspection.c
@@ -786,7 +786,7 @@ gupnp_service_introspection_list_action_names
* Returns a #GList of all the actions (of type #GUPnPServiceActionInfo) in
* this service.
*
- * Return value: (element-type GUPnP.ServiceActionInfo*) (transfer none): A
+ * Return value: (element-type GUPnP.ServiceActionInfo) (transfer none): A
* #GList of all the actions or %NULL. Do not modify or free it or its
* contents.
**/
@@ -855,7 +855,8 @@ state_variable_search_func (GUPnPServiceStateVariableInfo *variable,
*
* Returns the state variable by the name @variable_name in this service.
*
- * Return value: the state variable or %NULL. Do not modify or free it.
+ * Return value: (transfer none): the state variable or %NULL. Do not modify or
+ * free it.
**/
const GUPnPServiceStateVariableInfo *
gupnp_service_introspection_get_state_variable
diff --git a/libgupnp/gupnp-service-introspection.h b/libgupnp/gupnp-service-introspection.h
index 76d1dc3..54d9e90 100644
--- a/libgupnp/gupnp-service-introspection.h
+++ b/libgupnp/gupnp-service-introspection.h
@@ -85,7 +85,7 @@ typedef struct {
/**
* GUPnPServiceActionInfo:
* @name: The name of the action argument.
- * @arguments: A GList of all the arguments
+ * @arguments: (type GList) (element-type GUPnP.ServiceActionArgInfo):A GList of all the arguments
* (of type #GUPnPServiceActionArgInfo) of this action.
*
* This structure contains information about a service action.
@@ -109,7 +109,7 @@ typedef struct {
* data types.
* @step: The step value of this state variable. Only applies to numeric
* data types.
- * @allowed_values: The allowed values of this state variable. Only applies to
+ * @allowed_values: (element-type utf8): The allowed values of this state variable. Only applies to
* string data types. Unlike the other fields in this structure, this field
* contains a list of (char *) strings rather than GValues.
*
diff --git a/libgupnp/gupnp-service-proxy.c b/libgupnp/gupnp-service-proxy.c
index dc75ba1..04811ca 100644
--- a/libgupnp/gupnp-service-proxy.c
+++ b/libgupnp/gupnp-service-proxy.c
@@ -348,7 +348,7 @@ gupnp_service_proxy_class_init (GUPnPServiceProxyClass *klass)
/**
* GUPnPServiceProxy::subscription-lost:
* @proxy: The #GUPnPServiceProxy that received the signal
- * @error: A pointer to a #GError describing why the subscription has
+ * @error: (type GError):A pointer to a #GError describing why the subscription has
* been lost
*
* Emitted whenever the subscription to this service has been lost due
@@ -967,7 +967,7 @@ gupnp_service_proxy_begin_action_list
* @callback: (scope async): The callback to call when sending the action has succeeded
* or failed
* @user_data: User data for @callback
- * @hash: A #GHashTable of in parameter name and #GValue pairs
+ * @hash: (element-type utf8 GValue): A #GHashTable of in parameter name and #GValue pairs
*
* See gupnp_service_proxy_begin_action(); this version takes a #GHashTable
* for runtime generated parameter lists.
diff --git a/libgupnp/gupnp-service.c b/libgupnp/gupnp-service.c
index 76c3e9d..2eb2a43 100644
--- a/libgupnp/gupnp-service.c
+++ b/libgupnp/gupnp-service.c
@@ -458,7 +458,7 @@ gupnp_service_action_get_values (GUPnPServiceAction *action,
* gupnp_service_action_get_value: (skip)
* @action: A #GUPnPServiceAction
* @argument: The name of the argument to retrieve
- * @value: The #GValue to store the value of the argument, initialized
+ * @value: (inout):The #GValue to store the value of the argument, initialized
* to the correct type.
*
* Retrieves the value of @argument into @value.
@@ -1669,7 +1669,7 @@ gupnp_service_class_init (GUPnPServiceClass *klass)
* GUPnPService::query-variable:
* @service: The #GUPnPService that received the signal
* @variable: The variable that is being queried
- * @value: The location of the #GValue of the variable
+ * @value: (type GValue)(inout):The location of the #GValue of the variable
*
* Emitted whenever @service needs to know the value of @variable.
* Handler should fill @value with the value of @variable.
@@ -1692,8 +1692,8 @@ gupnp_service_class_init (GUPnPServiceClass *klass)
/**
* GUPnPService::notify-failed:
* @service: The #GUPnPService that received the signal
- * @callback_url: The callback URL
- * @reason: A pointer to a #GError describing why the notify failed
+ * @callback_url: (type GList)(element-type SoupURI):A #GList of callback URLs
+ * @reason: (type GError): A pointer to a #GError describing why the notify failed
*
* Emitted whenever notification of a client fails.
**/
diff --git a/libgupnp/gupnp-service.h b/libgupnp/gupnp-service.h
index d81e4b9..ae73c89 100644
--- a/libgupnp/gupnp-service.h
+++ b/libgupnp/gupnp-service.h
@@ -83,6 +83,7 @@ struct _GUPnPService {
struct _GUPnPServiceClass {
GUPnPServiceInfoClass parent_class;
+ /* action
with parameters Varargs
to the service exposed by
@@ -504,7 +504,7 @@ or failed. [GUPnPServiceProxy *proxy
,
const char *action
,
GUPnPServiceProxyActionCallback callback
,
- gpointer user_data
,
+ gpointer user_data
,
va_list var_args
);
gupnp_service_proxy_begin_action()
; this version takes a va_list for
@@ -554,10 +554,10 @@ be freed when calling GUPnPServiceProxy *proxy
,
const char *action
,
GUPnPServiceProxyActionCallback callback
,
- gpointer user_data
,
- GHashTable *hash
);
+ gpointer user_data
,
+ GHashTable *hash
);
gupnp_service_proxy_begin_action()
; this version takes a GHashTable
+See gupnp_service_proxy_begin_action()
; this version takes a GHashTable
for runtime generated parameter lists.
@@ -585,7 +585,8 @@ or failed. [
hash
 :
-A GHashTable of in parameter name and GValue pairs
+A GHashTable of in parameter name and GValue pairs. [element-type utf8 GValue]
+
@@ -603,10 +604,10 @@ be freed when calling GUPnPServiceProxyAction * gupnp_service_proxy_begin_action_list
(GUPnPServiceProxy *proxy
,
const char *action
,
- GList *in_names
,
- GList *in_values
,
+ GList *in_names
,
+ GList *in_values
,
GUPnPServiceProxyActionCallback callback
,
- gpointer user_data
);
+ gpointer user_data
);
in_names
 :
-GList of 'in' parameter
+GList of 'in' parameter
names (as strings). [element-type utf8][transfer none]
in_values
 :
-GList of values (as
-GValue) that line up with
in_names
. [element-type GValue][transfer none]
+GList of values (as
+GValue) that line up with in_names
. [element-type GValue][transfer none]
@@ -660,9 +661,9 @@ be freed when calling
gupnp_service_proxy_end_action ()
-gboolean gupnp_service_proxy_end_action (
GUPnPServiceProxy *proxy
,
+gboolean gupnp_service_proxy_end_action (
GUPnPServiceProxy *proxy
,
GUPnPServiceProxyAction *action
,
- GError **error
,
+ GError **error
,
...
);action
. The out parameters in Varargs
will be
@@ -683,13 +684,13 @@ a UPnPError the error code will be the same in error
-error
 :The location where to store any error, or NULL
+The location where to store any error, or
NULL
-
+TRUE
on success.TRUE
on success.
error
gupnp_service_proxy_end_action_valist ()
-gboolean gupnp_service_proxy_end_action_valist
+
gboolean gupnp_service_proxy_end_action_valist
(
GUPnPServiceProxy *proxy
,
GUPnPServiceProxyAction *action
,
- GError **error
,
+ GError **error
,
va_list var_args
);gupnp_service_proxy_end_action()
; this version takes a va_list for
@@ -720,7 +721,7 @@ use by language bindings.
-error
 :The location where to store any error, or NULL
+The location where to store any error, or
NULL
@@ -732,7 +733,7 @@ freed after use
-
+TRUE
on success.TRUE
on success.
gupnp_service_proxy_end_action_hash ()
-gboolean gupnp_service_proxy_end_action_hash (
GUPnPServiceProxy *proxy
,
+gboolean gupnp_service_proxy_end_action_hash (
+ GUPnPServiceProxy *proxy
,
GUPnPServiceProxyAction *action
,
- GError **error
,
- GHashTable *hash
);GError **error
,
+ GHashTable *hash
);gupnp_service_proxy_end_action()
; this version takes a GHashTable for
+See gupnp_service_proxy_end_action()
; this version takes a GHashTable for
runtime generated parameter lists.
@@ -762,19 +763,19 @@ runtime generated parameter lists.
-error
 :The location where to store any error, or NULL
+The location where to store any error, or
NULL
-hash
 :A GHashTable of
-out parameter name and initialised GValue pairs. [element-type utf8 GValue][inout][transfer none]
+ A GHashTable of
+out parameter name and initialised GValue pairs. [element-type utf8 GValue][inout][transfer none]
-
+TRUE
on success.TRUE
on success.
gupnp_service_proxy_end_action_list ()
-gboolean gupnp_service_proxy_end_action_list (
GUPnPServiceProxy *proxy
,
+gboolean gupnp_service_proxy_end_action_list (
+ GUPnPServiceProxy *proxy
,
GUPnPServiceProxyAction *action
,
- GError **error
,
- GList *out_names
,
- GList *out_types
,
- GList **out_values
);GError **error
,
+ GList *out_names
,
+ GList *out_types
,
+ GList **out_values
);out_values
must be freed using g_list_free and each element in it using
-g_value_unset and g_slice_free.
+in out_values
must be freed using g_list_free and each element in it using
+g_value_unset and g_slice_free.
TRUE
on success.
+Return value : TRUE
on success.
error
 :
-The location where to store any error, or NULL
+The location where to store any error, or
NULL
out_names
 :
-GList of 'out' parameter
+GList of 'out' parameter
names (as strings). [element-type utf8][transfer none]
out_types
 :
-GList of types (as GType)
+GList of types (as GType)
that line up with
out_names
. [element-type GType][transfer none]
@@ -864,11 +865,11 @@ Cancels out_values
 :
-GList of values
-(as GValue) that line up with
out_names
and out_types
. [element-type GValue][transfer full][out]
+GList of values
+(as GValue) that line up with out_names
and out_types
. [element-type GValue][transfer full][out]
action
, freeing the
gupnp_service_proxy_add_notify ()
-gboolean gupnp_service_proxy_add_notify (
GUPnPServiceProxy *proxy
,
+gboolean gupnp_service_proxy_add_notify (
+ GUPnPServiceProxy *proxy
,
const char *variable
,
- GType type
,
+ GType type
,
GUPnPServiceProxyNotifyCallback callback
,
- gpointer user_data
);gpointer user_data
);callback
to be called whenever a change notification for
variable
is recieved.
@@ -902,7 +903,7 @@ Sets up callback
to be called whenever a
-
+TRUE
on success.TRUE
on success.
callback
to be called whenever a
gupnp_service_proxy_remove_notify ()
-gboolean gupnp_service_proxy_remove_notify (
GUPnPServiceProxy *proxy
,
+gboolean gupnp_service_proxy_remove_notify (
+ GUPnPServiceProxy *proxy
,
const char *variable
,
GUPnPServiceProxyNotifyCallback callback
,
- gpointer user_data
);gpointer user_data
);callback
and user_data
.
callbac
-
+TRUE
on success.TRUE
on success.
callbac
gupnp_service_proxy_set_subscribed ()
void gupnp_service_proxy_set_subscribed (
+ GUPnPServiceProxy *proxy
,
- gboolean subscribed
);gboolean subscribed
);
subscribed
 :
-
+TRUE
to subscribe to this serviceTRUE
to subscribe to this service
gupnp_service_proxy_get_subscribed ()
-gboolean gupnp_service_proxy_get_subscribed (
+GUPnPServiceProxy *proxy
);gboolean gupnp_service_proxy_get_subscribed (
GUPnPServiceProxy *proxy
);
-
+TRUE
if we are subscribed to this service, otherwise FALSE
.TRUE
if we are subscribed to this service, otherwise FALSE
.
Property Details
The
-"subscribed"
property "subscribed" gboolean : Read / Write
+ "subscribed" gboolean : Read / Write
The
"subscription-lost"
signalvoid user_function (GUPnPServiceProxy *proxy,
- gpointer error,
- gpointer user_data) :
+ gpointer error,
+ gpointer user_data) : Run Last
Run Last
-error
 :A pointer to a GError describing why the subscription has
-been lost
+A pointer to a GError describing why the subscription has
+been lost. [type GError]
+
diff --git a/doc/html/GUPnPXMLDoc.html b/doc/html/GUPnPXMLDoc.html
index 2e4ae2a..38b9a11 100644
--- a/doc/html/GUPnPXMLDoc.html
+++ b/doc/html/GUPnPXMLDoc.html
@@ -42,13 +42,13 @@
user_data
 :struct GUPnPXMLDoc;
GUPnPXMLDoc * gupnp_xml_doc_new (
@@ -86,7 +86,7 @@ Create a new
xmlDoc *xml_doc
);
GUPnPXMLDoc * gupnp_xml_doc_new_from_path (const char *path
,
- GError **error
);
+ GError **error
);
@@ -95,7 +95,7 @@ Create a new
-A new GUPnPXMLDoc, or
+NULL
on an errorA new GUPnPXMLDoc, or
NULL
on an errorgupnp_xml_doc_new_from_path ()
GUPnPXMLDoc * gupnp_xml_doc_new_from_path (
+ const char *path
,
- GError **error
);GError **error
);
path
.
diff --git a/doc/html/annotation-glossary.html b/doc/html/annotation-glossary.html
index f2b328c..e128a1a 100644
--- a/doc/html/annotation-glossary.html
+++ b/doc/html/annotation-glossary.html
@@ -33,9 +33,9 @@
 |Â
E
 |Â
- T
- Â |Â
S
+ Â |Â
+ T
-A new GUPnPXMLDoc, or
+NULL
on an errorA new GUPnPXMLDoc, or
NULL
on an errorS
+T
S
service_proxy_available_cb
for each one it
@@ -152,7 +152,7 @@ service_proxy_available_cb (GUPnPControlPoint *cp,
sendEvents="yes"
. We'll demonstrate
@@ -187,7 +187,7 @@ service_proxy_available_cb (GUPnPControlPoint *cp,
-a GQuark uniquely used by GUPnP's server errors.
+a GQuark uniquely used by GUPnP's server errors.
@@ -125,13 +125,13 @@ is communication with another server.
#define GUPNP_EVENTING_ERROR (gupnp_eventing_error_quark ())
-a GQuark uniquely used by GUPnP's eventing errors.
+a GQuark uniquely used by GUPnP's eventing errors.
@@ -175,13 +175,13 @@ eventing of state variables.
#define GUPNP_CONTROL_ERROR (gupnp_control_error_quark ())
-a GQuark uniquely used by GUPnP's control errors.
+a GQuark uniquely used by GUPnP's control errors.
@@ -231,13 +231,13 @@ invocation of service actions.
#define GUPNP_XML_ERROR (gupnp_xml_error_quark ())
-a GQuark uniquely used by GUPnP XML processing errors.
+a GQuark uniquely used by GUPnP XML processing errors.
diff --git a/doc/html/gupnp-binding-tool.html b/doc/html/gupnp-binding-tool.html
index 640a753..8ec03f5 100644
--- a/doc/html/gupnp-binding-tool.html
+++ b/doc/html/gupnp-binding-tool.html
@@ -33,7 +33,7 @@
gupnp-binding-tool
[--prefix {PREFIX}] [--mode {client|server}] {SCPD file}Description
+Description
Client side bindings
+Client side bindings
Server side bindings
+Server side bindings
GUPnPServiceIntrospection *introspection
);
-const GList * gupnp_service_introspection_list_actions
+const GList * gupnp_service_introspection_list_actions
(GUPnPServiceIntrospection *introspection
);
const GUPnPServiceActionInfo * gupnp_service_introspection_get_action
(GUPnPServiceIntrospection *introspection
,
- const gchar *action_name
);
-const GList * gupnp_service_introspection_list_state_variable_names
+ const gchar *action_name
);
+const GList * gupnp_service_introspection_list_state_variable_names
(GUPnPServiceIntrospection *introspection
);
-const GList * gupnp_service_introspection_list_state_variables
+const GList * gupnp_service_introspection_list_state_variables
(GUPnPServiceIntrospection *introspection
);
const GUPnPServiceStateVariableInfo * gupnp_service_introspection_get_state_variable
(GUPnPServiceIntrospection *introspection
,
- const gchar *variable_name
);
+ const gchar *variable_name
);
-
@@ -180,9 +180,10 @@ This structure contains information about a service action.
+retval
;
Whether this argument is the return value of the action.
The name of the action argument.
-
+arguments
;
A GList of all the arguments
-(of type GUPnPServiceActionArgInfo) of this action.
+(of type GUPnPServiceActionArgInfo) of this action. [type GList][element-type GUPnP.ServiceActionArgInfo]
+
The name of the state variable.
-
+send_events
;
Whether this state variable can source events.
-
+is_numeric
;
Wether this state variable is a numeric type (integer and
float).
-
+type
;
The GType of this state variable.
-
+default_value
;
The default value of this state variable.
-
+minimum
;
The minimum value of this state variable. Only applies to numeric
data types.
-
+maximum
;
The maximum value of this state variable. Only applies to numeric
data types.
-
+step
;
The step value of this state variable. Only applies to numeric
data types.
-
+allowed_values
;
The allowed values of this state variable. Only applies to
string data types. Unlike the other fields in this structure, this field
-contains a list of (char *) strings rather than GValues.
+contains a list of (char *) strings rather than GValues. [element-type utf8]
+
gupnp_service_introspection_list_action_names ()
-const GList * gupnp_service_introspection_list_action_names
+
const GList * gupnp_service_introspection_list_action_names
(
GUPnPServiceIntrospection *introspection
);
(transfer none) (element-type utf8) : A GList of names of all
-the actions or
+the actions or NULL
. Do not modify or free it or its contents.NULL
. Do not modify or free it or its contents.
gupnp_service_introspection_list_actions ()
-const GList * gupnp_service_introspection_list_actions
+
const GList * gupnp_service_introspection_list_actions
(
GUPnPServiceIntrospection *introspection
);
@@ -306,8 +308,8 @@ this service.
@@ -318,7 +320,7 @@ contents. [A
-GList of all the actions or
NULL
. Do not modify or free it or its
-contents. [element-type GUPnP.ServiceActionInfo*][transfer none]
+GList of all the actions or NULL
. Do not modify or free it or its
+contents. [element-type GUPnP.ServiceActionInfo][transfer none]
gupnp_service_introspection_get_action ()
const GUPnPServiceActionInfo * gupnp_service_introspection_get_action
(
+ GUPnPServiceIntrospection *introspection
,
- const gchar *action_name
);const gchar *action_name
);
action_name
in this service.
action_name
@@ -346,10 +348,10 @@ it. [
-the action or NULL
. Do not modify or free
+the action or
NULL
. Do not modify or free
it. [transfer none]
gupnp_service_introspection_list_state_variable_names ()
-const GList * gupnp_service_introspection_list_state_variable_names
+
const GList * gupnp_service_introspection_list_state_variable_names
(
GUPnPServiceIntrospection *introspection
);
A GList of names of all
-the state variables or NULL
. Do not modify or free it or its contents. [element-type utf8][transfer none]
+A GList of names of all
+the state variables or
@@ -371,7 +373,7 @@ the state variables or
NULL
. Do not modify or free it or its contents. [element-type utf8][transfer none]
gupnp_service_introspection_list_state_variables ()
-const GList * gupnp_service_introspection_list_state_variables
+
const GList * gupnp_service_introspection_list_state_variables
(
GUPnPServiceIntrospection *introspection
);
@@ -399,7 +401,7 @@ its contents. [
-A GList of all the state variables or NULL
. Do not modify or free it or
+A GList of all the state variables or
NULL
. Do not modify or free it or
its contents. [element-type GUPnP.ServiceStateVariableInfo][transfer none]
gupnp_service_introspection_get_state_variable ()
const GUPnPServiceStateVariableInfo * gupnp_service_introspection_get_state_variable
(
+ GUPnPServiceIntrospection *introspection
,
- const gchar *variable_name
);const gchar *variable_name
);variable_name
in this service.
variable_name
-the state variable or
+NULL
. Do not modify or free it.the state variable or
NULL
. Do not modify or
+free it. [transfer none]
+variable_name
Property Details
The
-"scpd"
property "scpd" gpointer : Write / Construct Only
+ "scpd" gpointer : Write / Construct Only
BinaryLight1
device type, but if none of the
existing device types are suitable a custom device type can be created.
@@ -117,7 +118,7 @@
SwitchPower1
@@ -204,13 +205,13 @@
dataType
s, see section 2.3 of
- the UPnP
+ the UPnP
Device Architecture.