Top | ![]() |
![]() |
![]() |
![]() |
const char * | gupnp_service_action_get_name () |
GList * | gupnp_service_action_get_locales () |
void | gupnp_service_action_get () |
void | gupnp_service_action_get_valist () |
void | gupnp_service_action_get_value () |
GValue * | gupnp_service_action_get_gvalue () |
GList * | gupnp_service_action_get_values () |
void | gupnp_service_action_set () |
void | gupnp_service_action_set_valist () |
void | gupnp_service_action_set_value () |
void | gupnp_service_action_set_values () |
void | gupnp_service_action_return_success () |
void | gupnp_service_action_return_error () |
void | gupnp_service_action_return () |
SoupMessage * | gupnp_service_action_get_message () |
guint | gupnp_service_action_get_argument_count () |
void | gupnp_service_notify () |
void | gupnp_service_notify_valist () |
void | gupnp_service_notify_value () |
void | gupnp_service_freeze_notify () |
void | gupnp_service_thaw_notify () |
void | gupnp_service_signals_autoconnect () |
GUPnPService allows for handling incoming actions and state variable notification. GUPnPService implements the GUPnPServiceInfo interface.
const char *
gupnp_service_action_get_name (GUPnPServiceAction *action
);
Get the name of action
.
GList *
gupnp_service_action_get_locales (GUPnPServiceAction *action
);
Get an ordered (preferred first) GList of locales preferred by the client. Free list and elements after use.
void gupnp_service_action_get (GUPnPServiceAction *action
,...
);
Retrieves the specified action arguments.
void gupnp_service_action_get_valist (GUPnPServiceAction *action
,va_list var_args
);
gupnp_service_action_get_valist
is deprecated and should not be used in newly-written code.
See gupnp_service_action_get()
; this version takes a va_list for
use by language bindings.
void gupnp_service_action_get_value (GUPnPServiceAction *action
,const char *argument
,GValue *value
);
Retrieves the value of argument
into value
.
[skip]
GValue * gupnp_service_action_get_gvalue (GUPnPServiceAction *action
,const char *argument
,GType type
);
Retrieves the value of argument
into a GValue of type type
and returns it.
The method exists only and only to satify PyGI, please use
gupnp_service_action_get_value()
and ignore this if possible.
[rename-to gupnp_service_action_get_value]
action |
||
argument |
The name of the argument to retrieve |
|
type |
The type of argument to retrieve |
Value as GValue associated with action
.
g_value_unset()
and g_slice_free()
it after usage.
[transfer full]
Since: 0.14.0
GList * gupnp_service_action_get_values (GUPnPServiceAction *action
,GList *arg_names
,GList *arg_types
);
A variant of gupnp_service_action_get that uses GList instead of varargs.
action |
||
arg_names |
(element-type utf8) : A GList of argument names as string |
|
arg_types |
A GList of argument types as GType. |
[element-type GType] |
The values as GList of
GValue. g_list_free()
the returned list and g_value_unset()
and g_slice_free()
each element.
[element-type GValue][transfer full]
Since: 0.14.0
void gupnp_service_action_set (GUPnPServiceAction *action
,...
);
Sets the specified action return values.
void gupnp_service_action_set_valist (GUPnPServiceAction *action
,va_list var_args
);
gupnp_service_action_set_valist
is deprecated and should not be used in newly-written code.
See gupnp_service_action_set()
; this version takes a va_list for
use by language bindings.
void gupnp_service_action_set_value (GUPnPServiceAction *action
,const char *argument
,const GValue *value
);
Sets the value of argument
to value
.
void gupnp_service_action_set_values (GUPnPServiceAction *action
,GList *arg_names
,GList *arg_values
);
Sets the specified action return values.
action |
||
arg_names |
A GList of argument names. |
[element-type utf8][transfer none] |
arg_values |
The GList of values (as
GValues) that line up with |
[element-type GValue][transfer none] |
Since: 0.14.0
void
gupnp_service_action_return_success (GUPnPServiceAction *action
);
Return succesfully.
void gupnp_service_action_return_error (GUPnPServiceAction *action
,guint error_code
,const char *error_description
);
Return error_code
.
action |
||
error_code |
The error code |
|
error_description |
The error description, or |
void
gupnp_service_action_return (GUPnPServiceAction *action
);
gupnp_service_action_return
has been deprecated since version 1.4.2 and should not be used in newly-written code.
Use gupnp_service_action_return_success()
instead
Return succesfully.
SoupMessage *
gupnp_service_action_get_message (GUPnPServiceAction *action
);
Get the SoupMessage associated with action
. Mainly intended for
applications to be able to read HTTP headers received from clients.
Since: 0.14.0
guint
gupnp_service_action_get_argument_count
(GUPnPServiceAction *action
);
Get the number of IN arguments from the action
and return it.
Since: 0.18.0
void gupnp_service_notify (GUPnPService *service
,...
);
Notifies listening clients that the properties listed in Varargs
have changed to the specified values.
void gupnp_service_notify_valist (GUPnPService *service
,va_list var_args
);
gupnp_service_notify_valist
is deprecated and should not be used in newly-written code.
See gupnp_service_notify()
; this version takes a va_list for
use by language bindings.
void gupnp_service_notify_value (GUPnPService *service
,const char *variable
,const GValue *value
);
Notifies listening clients that variable
has changed to value
.
void
gupnp_service_freeze_notify (GUPnPService *service
);
Causes new notifications to be queued up until gupnp_service_thaw_notify()
is called.
void
gupnp_service_thaw_notify (GUPnPService *service
);
Sends out any pending notifications, and stops queuing of new ones.
void gupnp_service_signals_autoconnect (GUPnPService *service
,gpointer user_data
,GError **error
);
A convenience function that attempts to connect all possible
“action-invoked” and “query-variable” signals to
appropriate callbacks for the service service
. It uses service introspection
and GModule's introspective features. It is very simillar to
gtk_builder_connect_signals()
except that it attempts to guess the names of
the signal handlers on its own.
For this function to do its magic, the application must name the callback
functions for “action-invoked” signals by striping the CamelCase
off the action names and either prepend "on_" or append "_cb" to them. Same
goes for “query-variable” signals, except that "query_" should
be prepended to the variable name. For example, callback function for
GetSystemUpdateID
action should be either named as
"get_system_update_id_cb" or "on_get_system_update_id" and callback function
for the query of "SystemUpdateID" state variable should be named
query_system_update_id_cb
or
on_query_system_update_id
.
service
.