GUPnPService

typedef struct _GUPnPService GUPnPService;

This struct contains private data only, and should be accessed using the functions below.

GUPnPServiceAction

typedef struct _GUPnPServiceAction GUPnPServiceAction;

Opaque structure for holding in-progress action data.

gupnp_service_action_get_name ()

const char*         gupnp_service_action_get_name       (GUPnPServiceAction *action);

Get the name of action.

gupnp_service_action_get_locales ()

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.

gupnp_service_action_get ()

void                gupnp_service_action_get            (GUPnPServiceAction *action,
                                                         ...);

Retrieves the specified action arguments.

gupnp_service_action_get_valist ()

void                gupnp_service_action_get_valist     (GUPnPServiceAction *action,
                                                         va_list var_args);

See gupnp_service_action_get(); this version takes a va_list for use by language bindings.

gupnp_service_action_get_value ()

void                gupnp_service_action_get_value      (GUPnPServiceAction *action,
                                                         const char *argument,
                                                         GValue *value);

Retrieves the value of argument into value.

gupnp_service_action_set ()

void                gupnp_service_action_set            (GUPnPServiceAction *action,
                                                         ...);

Sets the specified action return values.

gupnp_service_action_set_valist ()

void                gupnp_service_action_set_valist     (GUPnPServiceAction *action,
                                                         va_list var_args);

See gupnp_service_action_set(); this version takes a va_list for use by language bindings.

gupnp_service_action_set_value ()

void                gupnp_service_action_set_value      (GUPnPServiceAction *action,
                                                         const char *argument,
                                                         const GValue *value);

Sets the value of argument to value.

gupnp_service_action_return ()

void                gupnp_service_action_return         (GUPnPServiceAction *action);

Return succesfully.

gupnp_service_action_return_error ()

void                gupnp_service_action_return_error   (GUPnPServiceAction *action,
                                                         guint error_code,
                                                         const char *error_description);

Return error_code.

gupnp_service_notify ()

void                gupnp_service_notify                (GUPnPService *service,
                                                         ...);

Notifies listening clients that the properties listed in Varargs have changed to the specified values.

gupnp_service_notify_valist ()

void                gupnp_service_notify_valist         (GUPnPService *service,
                                                         va_list var_args);

See gupnp_service_notify(); this version takes a va_list for use by language bindings.

gupnp_service_notify_value ()

void                gupnp_service_notify_value          (GUPnPService *service,
                                                         const char *variable,
                                                         const GValue *value);

Notifies listening clients that variable has changed to value.

gupnp_service_freeze_notify ()

void                gupnp_service_freeze_notify         (GUPnPService *service);

Causes new notifications to be queued up until gupnp_service_thaw_notify() is called.

gupnp_service_thaw_notify ()

void                gupnp_service_thaw_notify           (GUPnPService *service);

Sends out any pending notifications, and stops queuing of new ones.

gupnp_service_signals_autoconnect ()

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 glade_xml_signal_autoconnect() 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".

Note that this function will not work correctly if GModule is not supported on the platform or introspection is not available for service service.

WARNING: This function can not and therefore does not guarantee that the resulting signal connections will be correct as it depends heavily on a particular naming schemes described above.

The "root-device" property

  "root-device"              GUPnPRootDevice*      : Read / Write / Construct Only

The containing GUPnPRootDevice.

The "action-invoked" signal

void                user_function                      (GUPnPService       *service,
                                                        GUPnPServiceAction *action,
                                                        gpointer            user_data)      : Run Last / Has Details

Emitted whenever an action is invoked. Handler should process action and must call either gupnp_service_action_return() or gupnp_service_action_return_error().

The "notify-failed" signal

void                user_function                      (GUPnPService *service,
                                                        gpointer      callback_url,
                                                        gpointer      reason,
                                                        gpointer      user_data)         : Run Last

Emitted whenever notification of a client fails.

The "query-variable" signal

void                user_function                      (GUPnPService *service,
                                                        gchar        *variable,
                                                        gpointer      value,
                                                        gpointer      user_data)      : Run Last / Has Details

Emitted whenever service needs to know the value of variable. Handler should fill value with the value of variable.