![]() |
![]() |
![]() |
GUPnP Reference Manual | ![]() |
---|---|---|---|---|
GUPnPServiceProxyPrivate; GUPnPServiceProxy; GUPnPServiceProxyAction; typedef void (); GUPnPServiceProxy* gupnp_service_proxy_new (GUPnPContext *context, xmlDoc *doc, const char *udn, const char *type, const char *location); gboolean gupnp_service_proxy_send_action (GUPnPServiceProxy *proxy, const char *action, GError **error, ...); gboolean gupnp_service_proxy_send_action_valist (GUPnPServiceProxy *proxy, const char *action, GError **error, va_list var_args); GUPnPServiceProxyAction* gupnp_service_proxy_begin_action (GUPnPServiceProxy *proxy, const char *action, GUPnPServiceProxyActionCallback callback, gpointer user_data, GError **error, ...); GUPnPServiceProxyAction* gupnp_service_proxy_begin_action_valist (GUPnPServiceProxy *proxy, const char *action, GUPnPServiceProxyActionCallback callback, gpointer user_data, GError **error, va_list var_args); gboolean gupnp_service_proxy_end_action (GUPnPServiceProxy *proxy, GUPnPServiceProxyAction *action, GError **error, ...); gboolean gupnp_service_proxy_end_action_valist (GUPnPServiceProxy *proxy, GUPnPServiceProxyAction *action, GError **error, va_list var_args); void gupnp_service_proxy_cancel_action (GUPnPServiceProxy *proxy, GUPnPServiceProxyAction *action); gboolean gupnp_service_proxy_add_notify (GUPnPServiceProxy *proxy, const char *variable, GType type, GUPnPServiceProxyNotifyCallback callback, gpointer user_data); gboolean gupnp_service_proxy_remove_notify (GUPnPServiceProxy *proxy, const char *variable, GUPnPServiceProxyNotifyCallback callback, gpointer user_data); void gupnp_service_proxy_set_subscribed (GUPnPServiceProxy *proxy, gboolean subscribed); gboolean gupnp_service_proxy_get_subscribed (GUPnPServiceProxy *proxy);
GUPnPServiceProxy sends commands to a remote UPnP service and handles incoming event notifications. Service proxies also implement the GUPnPServiceInfo interface.
typedef struct _GUPnPServiceProxyAction GUPnPServiceProxyAction;
An opaque structure for holding in-progress action data.
GUPnPServiceProxy* gupnp_service_proxy_new (GUPnPContext *context, xmlDoc *doc, const char *udn, const char *type, const char *location);
context : |
A GUPnPContext |
doc : |
A device description document |
udn : |
The UDN of the device the service is contained in |
type : |
The type of the service to create a proxy for |
location : |
The location of the service description file |
Returns : | A GUPnPServiceProxy for the service with type type from
the device with UDN udn , as read from the device description file specified
by doc .
|
gboolean gupnp_service_proxy_send_action (GUPnPServiceProxy *proxy, const char *action, GError **error, ...);
Sends action action
with parameters Varargs
to the service exposed by
proxy
synchronously.
proxy : |
A GUPnPServiceProxy |
action : |
An action |
error : |
The location where to store any error, or NULL |
... : |
tuples of in parameter name, in paramater type, and in parameter value, followed by NULL, and then tuples of out paramater name, out parameter type, and out parameter value location, terminated with NULL |
Returns : | TRUE if sending the action was succesfull. |
gboolean gupnp_service_proxy_send_action_valist (GUPnPServiceProxy *proxy, const char *action, GError **error, va_list var_args);
See gupnp_service_proxy_send_action()
; this version takes a va_list for
use by language bindings.
proxy : |
A GUPnPServiceProxy |
action : |
An action |
error : |
The location where to store any error, or NULL |
var_args : |
va_list of tuples of in parameter name, in paramater type, and in parameter value, followed by NULL, and then tuples of out paramater name, out parameter type, and out parameter value location |
Returns : | TRUE if sending the action was succesfull. |
GUPnPServiceProxyAction* gupnp_service_proxy_begin_action (GUPnPServiceProxy *proxy, const char *action, GUPnPServiceProxyActionCallback callback, gpointer user_data, GError **error, ...);
Sends action action
with parameters Varargs
to the service exposed by
proxy
asynchronously, reporting the result by calling callback
.
proxy : |
A GUPnPServiceProxy |
action : |
An action |
callback : |
The callback to call when sending the action has succeeded or failed |
user_data : |
User data for callback
|
error : |
The location where to store any error, or NULL |
... : |
tuples of in parameter name, in paramater type, and in parameter value, terminated with NULL |
Returns : | A GUPnPServiceProxyAction handle. This will be freed
automatically on callback calling.
|
GUPnPServiceProxyAction* gupnp_service_proxy_begin_action_valist (GUPnPServiceProxy *proxy, const char *action, GUPnPServiceProxyActionCallback callback, gpointer user_data, GError **error, va_list var_args);
See gupnp_service_proxy_begin_action()
; this version takes a va_list for
use by language bindings.
proxy : |
A GUPnPServiceProxy |
action : |
An action |
callback : |
The callback to call when sending the action has succeeded or failed |
user_data : |
User data for callback
|
error : |
The location where to store any error, or NULL |
var_args : |
A va_list of tuples of in parameter name, in paramater type, and in parameter value |
Returns : | A GUPnPServiceProxyAction handle, or NULL on error. This will
be freed automatically on callback calling.
|
gboolean gupnp_service_proxy_end_action (GUPnPServiceProxy *proxy, GUPnPServiceProxyAction *action, GError **error, ...);
Retrieves the result of action
. The out parameters in Varargs
will be
filled in, and ff an error occurred, error
will be set.
proxy : |
A GUPnPServiceProxy |
action : |
A GUPnPServiceProxyAction handle |
error : |
The location where to store any error, or NULL |
... : |
tuples of out parameter name, out paramater type, and out parameter value location, terminated with NULL. The out parameter values should be freed after use |
Returns : | TRUE on success. |
gboolean gupnp_service_proxy_end_action_valist (GUPnPServiceProxy *proxy, GUPnPServiceProxyAction *action, GError **error, va_list var_args);
See gupnp_service_proxy_end_action()
; this version takes a va_list for
use by language bindings.
proxy : |
A GUPnPServiceProxy |
action : |
A GUPnPServiceProxyAction handle |
error : |
The location where to store any error, or NULL |
var_args : |
A va_list of tuples of out parameter name, out paramater type, and out parameter value location. The out parameter values should be freed after use |
Returns : | TRUE on success. |
void gupnp_service_proxy_cancel_action (GUPnPServiceProxy *proxy, GUPnPServiceProxyAction *action);
Cancels action
, freeing the action
handle.
proxy : |
A GUPnPServiceProxy |
action : |
A GUPnPServiceProxyAction handle |
gboolean gupnp_service_proxy_add_notify (GUPnPServiceProxy *proxy, const char *variable, GType type, GUPnPServiceProxyNotifyCallback callback, gpointer user_data);
Sets up callback
to be called whenever a change notification for
variable
is recieved.
proxy : |
A GUPnPServiceProxy |
variable : |
The variable to add notification for |
type : |
The type of the variable |
callback : |
The callback to call when variable changes
|
user_data : |
User data for callback
|
Returns : | TRUE on success. |
gboolean gupnp_service_proxy_remove_notify (GUPnPServiceProxy *proxy, const char *variable, GUPnPServiceProxyNotifyCallback callback, gpointer user_data);
Cancels the variable change notification for callback
and user_data
.
proxy : |
A GUPnPServiceProxy |
variable : |
The variable to add notification for |
callback : |
The callback to call when variable changes
|
user_data : |
User data for callback
|
Returns : | TRUE on success. |
void gupnp_service_proxy_set_subscribed (GUPnPServiceProxy *proxy, gboolean subscribed);
(Un)subscribes to this service.
Note that the relevant messages are not immediately sent but queued. If you want to unsubcribe from this service because the application is quitting, rely on automatic synchronised unsubscription on object destruction instead.
proxy : |
A GUPnPServiceProxy |
subscribed : |
TRUE to subscribe to this service |
gboolean gupnp_service_proxy_get_subscribed (GUPnPServiceProxy *proxy);
proxy : |
A GUPnPServiceProxy |
Returns : | TRUE if we are subscribed to this service. |
void user_function (GUPnPServiceProxy *proxy, gpointer error, gpointer user_data) : Run Last
Emitted whenever the subscription to this service has been lost due to an error condition.
proxy : |
The GUPnPServiceProxy that received the signal |
error : |
A pointer to a GError describing why the subscription has been lost |
user_data : |
user data set when the signal handler was connected. |