php-doc-en/reference/gupnp/functions/gupnp-service-proxy-callback-set.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.gupnp-service-proxy-callback-set" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>gupnp_service_proxy_callback_set</refname>
  <refpurpose>Set service proxy callback for signal</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>gupnp_service_proxy_callback_set</methodname>
   <methodparam><type>resource</type><parameter>proxy</parameter></methodparam>
   <methodparam><type>int</type><parameter>signal</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>callback</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>arg</parameter></methodparam>
  </methodsynopsis>
  <para>
   Set service proxy callback for signal.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>proxy</parameter></term>
     <listitem>
      <para>
       A service proxy identifier.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>signal</parameter></term>
     <listitem>
      <para>
       The value of signal.
       <variablelist>
        <varlistentry>
         <term><constant>GUPNP_SIGNAL_SUBSCRIPTION_LOST</constant></term>
         <listitem>
          <simpara>
           Emitted whenever the subscription to this service has been lost due 
           to an error condition.
          </simpara>
         </listitem>
        </varlistentry>
       </variablelist>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>callback</parameter></term>
     <listitem>
      <para>
       The callback function for the certain signal. Typically, callback function 
       takes on two parameters.  <parameter>error</parameter> parameter's message 
       being the first, and the <parameter>arg</parameter> is second.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>arg</parameter></term>
     <listitem>
      <para>
       User data for <parameter>callback</parameter>. 
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Issues E_WARNING either with not valid callback function or with not valid signal. 
  </para>
 </refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->