gupnp-service-proxy.xml

另一 UPNP SDK 支持在UNIX/LINUX上运行。 UPnP是一种网络协议

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GUPnPServiceProxy">
<refmeta>
<refentrytitle role="top_of_page" id="GUPnPServiceProxy.top_of_page">GUPnPServiceProxy</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GUPNP Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GUPnPServiceProxy</refname>
<refpurpose>Proxy class for remote services.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="GUPnPServiceProxy.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="GUPnPServiceProxy-struct">GUPnPServiceProxy</link>;
                    <link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link>;
<link linkend="void">void</link>                (<link linkend="GUPnPServiceProxyActionCallback">*GUPnPServiceProxyActionCallback</link>)  (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         <link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link> *action,
                                                         <link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link>                (<link linkend="GUPnPServiceProxyNotifyCallback">*GUPnPServiceProxyNotifyCallback</link>)  (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="GValue">GValue</link> *value,
                                                         <link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-service-proxy-send-action">gupnp_service_proxy_send_action</link>     (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GError">GError</link> **error,
                                                         ...);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-service-proxy-send-action-valist">gupnp_service_proxy_send_action_valist</link>
                                                        (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GError">GError</link> **error,
                                                         <link linkend="va-list">va_list</link> var_args);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-service-proxy-send-action-hash">gupnp_service_proxy_send_action_hash</link>
                                                        (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GError">GError</link> **error,
                                                         <link linkend="GHashTable">GHashTable</link> *in_hash,
                                                         <link linkend="GHashTable">GHashTable</link> *out_hash);
<link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link>* <link linkend="gupnp-service-proxy-begin-action">gupnp_service_proxy_begin_action</link>
                                                        (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GUPnPServiceProxyActionCallback">GUPnPServiceProxyActionCallback</link> callback,
                                                         <link linkend="gpointer">gpointer</link> user_data,
                                                         ...);
<link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link>* <link linkend="gupnp-service-proxy-begin-action-valist">gupnp_service_proxy_begin_action_valist</link>
                                                        (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GUPnPServiceProxyActionCallback">GUPnPServiceProxyActionCallback</link> callback,
                                                         <link linkend="gpointer">gpointer</link> user_data,
                                                         <link linkend="va-list">va_list</link> var_args);
<link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link>* <link linkend="gupnp-service-proxy-begin-action-hash">gupnp_service_proxy_begin_action_hash</link>
                                                        (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *action,
                                                         <link linkend="GUPnPServiceProxyActionCallback">GUPnPServiceProxyActionCallback</link> callback,
                                                         <link linkend="gpointer">gpointer</link> user_data,
                                                         <link linkend="GHashTable">GHashTable</link> *hash);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-service-proxy-end-action">gupnp_service_proxy_end_action</link>      (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         <link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link> *action,
                                                         <link linkend="GError">GError</link> **error,
                                                         ...);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-service-proxy-end-action-valist">gupnp_service_proxy_end_action_valist</link>
                                                        (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         <link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link> *action,
                                                         <link linkend="GError">GError</link> **error,
                                                         <link linkend="va-list">va_list</link> var_args);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-service-proxy-end-action-hash">gupnp_service_proxy_end_action_hash</link> (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         <link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link> *action,
                                                         <link linkend="GError">GError</link> **error,
                                                         <link linkend="GHashTable">GHashTable</link> *hash);
<link linkend="void">void</link>                <link linkend="gupnp-service-proxy-cancel-action">gupnp_service_proxy_cancel_action</link>   (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         <link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link> *action);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-service-proxy-add-notify">gupnp_service_proxy_add_notify</link>      (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="GType">GType</link> type,
                                                         <link linkend="GUPnPServiceProxyNotifyCallback">GUPnPServiceProxyNotifyCallback</link> callback,
                                                         <link linkend="gpointer">gpointer</link> user_data);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-service-proxy-remove-notify">gupnp_service_proxy_remove_notify</link>   (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         const <link linkend="char">char</link> *variable,
                                                         <link linkend="GUPnPServiceProxyNotifyCallback">GUPnPServiceProxyNotifyCallback</link> callback,
                                                         <link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link>                <link linkend="gupnp-service-proxy-set-subscribed">gupnp_service_proxy_set_subscribed</link>  (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         <link linkend="gboolean">gboolean</link> subscribed);
<link linkend="gboolean">gboolean</link>            <link linkend="gupnp-service-proxy-get-subscribed">gupnp_service_proxy_get_subscribed</link>  (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GUPnPServiceProxy.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GUPnPServiceInfo">GUPnPServiceInfo</link>
         +----GUPnPServiceProxy
</synopsis>

</refsect1>





<refsect1 id="GUPnPServiceProxy.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GUPnPServiceProxy--subscribed">subscribed</link>&quot;               <link linkend="gboolean">gboolean</link>              : Read / Write
</synopsis>
</refsect1>

<refsect1 id="GUPnPServiceProxy.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GUPnPServiceProxy-subscription-lost">subscription-lost</link>&quot;                              : Run Last
</synopsis>
</refsect1>


<refsect1 id="GUPnPServiceProxy.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link> sends commands to a remote UPnP service and handles
incoming event notifications. <link linkend="GUPnPServiceProxy"><type>GUPnPServiceProxy</type></link> implements the
<link linkend="GUPnPServiceInfo"><type>GUPnPServiceInfo</type></link> interface.</para>
<para>

</para>
</refsect1>

<refsect1 id="GUPnPServiceProxy.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GUPnPServiceProxy-struct" role="struct">
<title>GUPnPServiceProxy</title>
<indexterm zone="GUPnPServiceProxy-struct"><primary>GUPnPServiceProxy</primary></indexterm><programlisting>typedef struct _GUPnPServiceProxy GUPnPServiceProxy;</programlisting>
<para>
This struct contains private data only, and should be accessed using the
functions below.</para>
<para>

</para></refsect2>
<refsect2 id="GUPnPServiceProxyAction" role="struct">
<title>GUPnPServiceProxyAction</title>
<indexterm zone="GUPnPServiceProxyAction"><primary>GUPnPServiceProxyAction</primary></indexterm><programlisting>typedef struct _GUPnPServiceProxyAction GUPnPServiceProxyAction;</programlisting>
<para>
Opaque structure for holding in-progress action data.</para>
<para>

</para></refsect2>
<refsect2 id="GUPnPServiceProxyActionCallback" role="function">
<title>GUPnPServiceProxyActionCallback ()</title>
<indexterm zone="GUPnPServiceProxyActionCallback"><primary>GUPnPServiceProxyActionCallback</primary></indexterm><programlisting><link linkend="void">void</link>                (*GUPnPServiceProxyActionCallback)  (<link linkend="GUPnPServiceProxy">GUPnPServiceProxy</link> *proxy,
                                                         <link linkend="GUPnPServiceProxyAction">GUPnPServiceProxyAction</link> *action,
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Callback notifying that <parameter>action</parameter> on <parameter>proxy</parameter> has returned and
<link linkend="gupnp-service-proxy-end-action"><function>gupnp_service_proxy_end_action()</function></link> etc can be called.</para>
<para>