uTools-Manuals/docs/php/gupnp_service_proxy_add_notify.html
2019-04-28 19:00:34 +08:00

200 lines
5.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Sets up callback for variable change notification</title>
</head>
<body class="docs"><div id="layout">
<div id="layout-content"><div id="function.gupnp-service-proxy-add-notify" class="refentry">
<div class="refnamediv">
<h1 class="refname">gupnp_service_proxy_add_notify</h1>
<p class="verinfo">(PECL gupnp &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_service_proxy_add_notify</span> &mdash; <span class="dc-title">Sets up callback for variable change notification</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.gupnp-service-proxy-add-notify-description">
<h3 class="title">说明</h3>
<div class="methodsynopsis dc-description">
<span class="methodname"><strong>gupnp_service_proxy_add_notify</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$proxy</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$callback</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$arg</code></span>
] ) : <span class="type">bool</span></div>
<p class="para rdfs-comment">
Sets up callback to be called whenever a change notification for variable is recieved.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.gupnp-service-proxy-add-notify-parameters">
<h3 class="title">参数</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">proxy</code></dt>
<dd>
<p class="para">
A service proxy identifier.
</p>
</dd>
<dt>
<code class="parameter">value</code></dt>
<dd>
<p class="para">
The variable to add notification for.
</p>
</dd>
<dt>
<code class="parameter">type</code></dt>
<dd>
<p class="para">
The type of the variable. Type can be one of the following values:
<dl>
<dt>
<strong><code>GUPNP_TYPE_BOOLEAN</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is boolean.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_INT</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is integer.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_LONG</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is long.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_DOUBLE</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is double.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_FLOAT</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is float.
</span>
</dd>
<dt>
<strong><code>GUPNP_TYPE_STRING</code></strong></dt>
<dd>
<span class="simpara">
Type of the variable is string.
</span>
</dd>
</dl>
</p>
</dd>
<dt>
<code class="parameter">callback</code></dt>
<dd>
<p class="para">
The callback to call when variable changes. Typically, callback function
takes on three parameters. The <code class="parameter">variable</code>
parameter being the first, <code class="parameter">value</code> parameter
being the second, and the <code class="parameter">arg</code> is third.
</p>
</dd>
<dt>
<code class="parameter">arg</code></dt>
<dd>
<p class="para">
User data for <code class="parameter">callback</code>.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gupnp-service-proxy-add-notify-returnvalues">
<h3 class="title">返回值</h3>
<p class="para">
成功时返回 <strong><code>TRUE</code></strong> 或者在失败时返回 <strong><code>FALSE</code></strong>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.gupnp-service-proxy-add-notify-seealso">
<h3 class="title">参见</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="gupnp_service_proxy_remove_notify.html" class="function" rel="rdfs-seeAlso">gupnp_service_proxy_remove_notify()</a> - Cancels the variable change notification</span></li>
</ul>
</p>
</div>
</div></div></div></body></html>