From: Regis Merlino
GUPnPContext implements
- GInitable.Synopsis
struct GUPnPContext;
-GUPnPContext * gupnp_context_new (
@@ -74,8 +74,8 @@ const char *
GMainContext *main_context
,
- const char *interface
,
- guint port
,
- GError **error
);
+GUPnPContext * gupnp_context_new (GMainContext *main_context
,
+ const char *iface
,
+ guint port
,
+ GError **error
);
const char * gupnp_context_get_host_ip (GUPnPContext *context
);
-guint gupnp_context_get_port (GUPnPContext *context
);
-SoupServer * gupnp_context_get_server (GUPnPContext *context
);
-SoupSession * gupnp_context_get_session (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 - "server" SoupServer* : Read - "session" SoupSession* : Read - "subscription-timeout" 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
For debugging, it is possible to see the messages being sent and received by
-exporting GUPNP_DEBUG.
+exporting GUPNP_DEBUG
.
GUPnPContext * gupnp_context_new (+GMainContext *main_context
, -const char *interface
, -guint port
, -GError **error
);
GUPnPContext * gupnp_context_new (GMainContext *main_context
, +const char *iface
, +guint port
, +GError **error
);
-Create a new GUPnPContext with the specified main_context
, interface
and
+Create a new GUPnPContext with the specified main_context
, iface
and
port
.
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. @@ -189,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.
@@ -211,9 +211,9 @@ Get the port that the SOAP server is running on.SoupServer * gupnp_context_get_server (GUPnPContext *context
);
+SoupServer * gupnp_context_get_server (GUPnPContext *context
);
-Get the SoupServer HTTP server that GUPnP is using. +Get the SoupServer HTTP server that GUPnP is using.
Returns : |
-The SoupServer used by GUPnP. Do not unref this when finished. [transfer none] + | The SoupServer used by GUPnP. Do not unref this when finished. [transfer none] |
Returns : |
-The SoupSession used by GUPnP. Do not unref + | The SoupSession used by GUPnP. Do not unref this when finished. [transfer none] |
|
-The user-agent as a GRegex. | +The user-agent as a GRegex. |
Returns : |
-TRUE on success, FALSE otherwise. |
+
server_path
"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 @@ -460,7 +460,7 @@ exist. The property defaults to 'en'.
"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.
@@ -469,23 +469,23 @@ The port to run on. Set to 0 if you don't care what port to run on."server"
property "server" SoupServer* : Read
+"server" SoupServer* : Read
-The SoupServer HTTP server used by GUPnP. +The SoupServer HTTP server used by GUPnP.
"session"
property "session" SoupSession* : Read
+"session" SoupSession* : Read
-The SoupSession object used by GUPnP. +The SoupSession object used by GUPnP.
"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 40cb7a8..632a8ee 100644 --- a/doc/html/GUPnPContextManager.html +++ b/doc/html/GUPnPContextManager.html @@ -44,36 +44,37 @@
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
); void gupnp_context_manager_manage_root_device (GUPnPContextManager *manager
,GUPnPRootDevice *root_device
); +guint gupnp_context_manager_get_port (GUPnPContextManager *manager
);
- "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 Only
- "context-available" :Run Last
- "context-unavailable" :Run First
+ "context-available" :Run Last
+ "context-unavailable" :Run First
GUPnPContextManager * gupnp_context_manager_new (+GMainContext *main_context
, -guint port
);
GUPnPContextManager * gupnp_context_manager_new (GMainContext *main_context
, +guint port
);
gupnp_context_manager_new
has been deprecated since version 0.17.2 and should not be used in newly-written code. Use gupnp_context_manager_create()
.
main_context
 :
-NULL
. If you want to use
+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]
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 @@ -209,18 +210,40 @@ usually want to call this function from
guint gupnp_context_manager_get_port (GUPnPContextManager *manager
);
++Get the network port associated with this context manager. +
+
|
+A GUPnPContextManager + | +
Returns : |
+The network port asssociated with this context manager. | +
"main-context"
property "main-context" gpointer : Read / Write / Construct Only
+"main-context" gpointer : Read / Write / Construct Only
GMainContext to pass to created GUPnPContext objects.
"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 +257,7 @@ port is used by
"context-available"
signalvoid user_function (GUPnPContextManager *context_manager,
GUPnPContext *context,
- gpointer user_data) : Run Last
+ gpointer user_data) : Run Last
Signals the availability of new GUPnPContext.
@@ -262,7 +285,7 @@ Signals the availability of new"context-unavailable"
signalvoid user_function (GUPnPContextManager *context_manager,
GUPnPContext *context,
- gpointer user_data) : Run First
+ gpointer user_data) : Run First
Signals the unavailability of a GUPnPContext.
diff --git a/doc/html/GUPnPControlPoint.html b/doc/html/GUPnPControlPoint.html index a2d9fe2..f3aa9f1 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
);
- GObject - +----GSSDPResourceBrowser + GObject + +----GSSDPResourceBrowser +----GUPnPControlPoint
- "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
GUPnPControlPoint handles device and service discovery. After creating
-a control point and activating it using
-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.
Returns :
-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.
Returns :
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 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 signal is emitted whenever a new
service has become available.
@@ -376,7 +376,7 @@ service has become available.
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 ec1c3e7..8c7b8fc 100644
--- a/doc/html/GUPnPDevice.html
+++ b/doc/html/GUPnPDevice.html
@@ -47,7 +47,7 @@
Get the URL base of this device.
Returns : Returns : Returns : Returns :gssdp_resource_browser_set_active()
,
+a control point and activating it using gssdp_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
);
@@ -239,7 +239,7 @@ nor its elements.
@@ -249,10 +249,10 @@ nor its elements.
-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
);
@@ -265,7 +265,7 @@ list nor its elements.
@@ -289,7 +289,7 @@ The resource factory to use. Set to NULL for default factory.
-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-unavailable"
signalvoid user_function (GUPnPControlPoint *control_point,
GUPnPDeviceProxy *proxy,
- gpointer user_data) :
+ gpointer user_data) : Run Last
Run Last
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-unavailable"
signalvoid user_function (GUPnPControlPoint *control_point,
GUPnPServiceProxy *proxy,
- gpointer user_data) :
+ gpointer user_data) : Run Last
Run Last
Object Hierarchy
- GObject
+ GObject
+----GUPnPDeviceInfo
+----GUPnPDevice
+----GUPnPRootDevice
diff --git a/doc/html/GUPnPDeviceInfo.html b/doc/html/GUPnPDeviceInfo.html
index a8caa66..45c450a 100644
--- a/doc/html/GUPnPDeviceInfo.html
+++ b/doc/html/GUPnPDeviceInfo.html
@@ -46,7 +46,7 @@
(
GUPnPDeviceInfo *device_info
);
GUPnPContext * gupnp_device_info_get_context (GUPnPDeviceInfo *info
);
const char * gupnp_device_info_get_location (GUPnPDeviceInfo *info
);
-const SoupURI * gupnp_device_info_get_url_base (GUPnPDeviceInfo *info
);
+const SoupURI * gupnp_device_info_get_url_base (GUPnPDeviceInfo *info
);
const char * gupnp_device_info_get_udn (GUPnPDeviceInfo *info
);
const char * gupnp_device_info_get_device_type (GUPnPDeviceInfo *info
);
char * gupnp_device_info_get_friendly_name (GUPnPDeviceInfo *info
);
@@ -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" SoupURI* : Read / Write / Construct Only
+ "udn" gchar* : Read / Write / Construct Only
+ "url-base" SoupURI* : Read / Write / Construct Only
gupnp_device_info_get_url_base ()
-const SoupURI * gupnp_device_info_get_url_base (
+GUPnPDeviceInfo *info
);const SoupURI * gupnp_device_info_get_url_base (
GUPnPDeviceInfo *info
);
-A SoupURI.
+A SoupURI.
-A constant string, or
+NULL
.A constant string, or
NULL
.
-A string, or
+NULL
. g_free()
after use.A string, or
NULL
. g_free()
after use.
-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.Returns :
NULL
. g_free()
after use.NULL
. g_free()
after use.Returns :
NULL
. g_free()
after use.NULL
. g_free()
after use.Returns :
NULL
. g_free()
after use.NULL
. g_free()
after use.Returns :
NULL
. g_free()
after use.NULL
. g_free()
after use.Returns :
NULL
. g_free()
after use.NULL
. g_free()
after use.Returns :
NULL
. g_free()
after use.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]
NULL
for any. [
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]
NULL
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.
@@ -456,7 +455,7 @@ that line up without_names
.GUPnPServiceProxy *proxy
,const char *action
,GUPnPServiceProxyActionCallback callback
, -gpointer user_data
, +gpointer user_data
,...
);
Sends action
-See
-See
A variant of gupnp_service_proxy_begin_action that takes lists of
in-parameter names, types and values.
@@ -627,15 +625,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
+This function must not be called directly or indirectly from a
+GUPnPServiceProxyNotifyCallback associated with this service proxy, even
+if it is for another variable.
+ 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.
@@ -1033,7 +1035,7 @@ to an error condition.
action
with parameters Varargs
to the service exposed by
@@ -504,11 +503,10 @@ 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
-use by language bindings.
+See gupnp_service_proxy_begin_action()
.
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 +583,7 @@ or failed. [
hash
 :
-A GHashTable of in parameter name and GValue pairs. [element-type utf8 GValue]
+ A GHashTable of in parameter name and GValue pairs. [element-type utf8 GValue]
@@ -604,10 +602,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]
@@ -661,9 +659,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
@@ -684,13 +682,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
-use by language bindings.
+See gupnp_service_proxy_end_action()
.
-error
 :The location where to store any error, or NULL
+The location where to store any error, or
NULL
@@ -733,7 +730,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.
@@ -763,19 +760,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.
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]
@@ -865,11 +862,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.
@@ -903,7 +900,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
 :
struct GUPnPXMLDoc; GUPnPXMLDoc * gupnp_xml_doc_new (@@ -86,7 +86,7 @@ Create a newxmlDoc *xml_doc
); GUPnPXMLDoc * gupnp_xml_doc_new_from_path (const char *path
, -GError **error
); +GError **error
);
Returns :
NULL
on an errorNULL
on an errorGUPnPXMLDoc * gupnp_xml_doc_new_from_path (+const char *path
, -GError **error
);
GError **error
);
Create a new GUPnPXMLDoc for the XML document at path
.
Returns :
NULL
on an errorNULL
on an errorThis 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 @@ -66,7 +66,9 @@ main (int argc, char **argv) GUPnPControlPoint *cp; /* Required initialisation */ - g_type_init (); + #if !GLIB_CHECK_VERSION(2,35,0) + g_type_init (); + #endif /* Create a new GUPnP Context. By here we are using the default GLib main context, and connecting to the current machine's default IP on an @@ -102,7 +104,7 @@ main (int argc, char **argv)
Now we have an application which searches for the service we specified and
calls service_proxy_available_cb
for each one it
@@ -152,7 +154,7 @@ service_proxy_available_cb (GUPnPControlPoint *cp,
It is possible to get change notifications for the service state variables
that have attribute sendEvents="yes"
. We'll demonstrate
@@ -187,7 +189,7 @@ service_proxy_available_cb (GUPnPControlPoint *cp,
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 a565d32..305f420 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 :
-GError codes used for errors in the GUPNP_SERVER_ERROR domain, when there
+GError codes used for errors in the GUPNP_SERVER_ERROR domain, when there
is communication with another server.
-The GQuark uniquely used by GUPnP's eventing errors.
+The GQuark uniquely used by GUPnP's eventing errors.
Returns :
-GError codes used for errors in the GUPNP_EVENTING_ERROR domain, during
+GError codes used for errors in the GUPNP_EVENTING_ERROR domain, during
eventing of state variables.
-The GQuark uniquely used by GUPnP's control errors.
+The GQuark uniquely used by GUPnP's control errors.
Returns :
-GError codes used for errors in the GUPNP_CONTROL_ERROR domain, during
+GError codes used for errors in the GUPNP_CONTROL_ERROR domain, during
invocation of service actions.
-The GQuark uniquely used by GUPnP XML processing errors.
+The GQuark uniquely used by GUPnP XML processing errors.
Returns :
-GError codes used for errors in the GUPNP_XML_ERROR domain, during
+GError codes used for errors in the GUPNP_XML_ERROR domain, during
processing of XML data.
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 f791ba3..25e3d5e 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.
@@ -283,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 :
Returns a GList of all the state variables (of type
@@ -389,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.19.1
+ Version 0.20.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 3dc7333..87a8347 100644
--- a/doc/html/index.sgml
+++ b/doc/html/index.sgml
@@ -170,6 +170,7 @@
This chapter explains how to implement a UPnP service using GUPnP. For
this example we will create a virtual UPnP-enabled light bulb.
@@ -42,7 +42,7 @@
The first step is to write the device description
file. This is a short XML document which describes the device and what
@@ -118,7 +118,7 @@
Because we are using a standard service we can use the service description
from the specification. This is the
Before starting to implement the device, some boilerplate code is needed
to initialise GUPnP. GLib types and threading needs to be initialised,
@@ -219,7 +219,9 @@
@@ -247,7 +249,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
@@ -356,7 +358,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/doc/server-tutorial.xml b/doc/server-tutorial.xml
index 4066bcc..06f1501 100644
--- a/doc/server-tutorial.xml
+++ b/doc/server-tutorial.xml
@@ -129,7 +129,9 @@
-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 8ec03f5..4db7fc0 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,7 +180,7 @@ 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. [type GList][element-type GUPnP.ServiceActionArgInfo]
@@ -214,39 +214,39 @@ This structure contains information about service state variable.
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. [element-type utf8]
@@ -267,7 +267,7 @@ functions below.
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.
NULL
. Do not modify or free it or it
gupnp_service_introspection_list_actions ()
-const GList * gupnp_service_introspection_list_actions
+
const GList * gupnp_service_introspection_list_actions
(
GUPnPServiceIntrospection *introspection
);
@@ -308,7 +308,7 @@ this service.
@@ -320,7 +320,7 @@ contents. [A
-GList of all the actions or
NULL
. Do not modify or free it or its
+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
@@ -348,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
);
@@ -373,7 +373,7 @@ the state variables or
-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
NULL
. Do not modify or free it or its contents. [element-type utf8][transfer none]
NULL
. Do not modify or free
gupnp_service_introspection_list_state_variables ()
-const GList * gupnp_service_introspection_list_state_variables
+
const GList * gupnp_service_introspection_list_state_variables
(
GUPnPServiceIntrospection *introspection
);
@@ -401,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
@@ -431,7 +431,7 @@ free it. [
-the state variable or NULL
. Do not modify or
+the state variable or
NULL
. Do not modify or
free it. [transfer none]
Property Details
The
-"scpd"
property "scpd" gpointer : Write / Construct Only
+ "scpd" gpointer : Write / Construct Only
G
@@ -176,6 +176,8 @@
SwitchPower1
@@ -211,7 +211,7 @@
GUPnPContext *context;
/* Initialize required subsystems */
-g_type_init ();
+#if !GLIB_CHECK_VERSION(2,35,0)
+ g_type_init ();
+#endif
/* Create the GUPnP context with default host and port */
context = gupnp_context_new (NULL, NULL, 0, NULL);