mirror of
https://github.com/fofolee/uTools-Manuals.git
synced 2025-06-18 05:26:57 +08:00
164 lines
5.3 KiB
HTML
164 lines
5.3 KiB
HTML
<!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>Set device callback function</title>
|
||
</head>
|
||
<body class="docs"><div id="layout">
|
||
<div id="layout-content"><div id="function.gupnp-device-action-callback-set" class="refentry">
|
||
<div class="refnamediv">
|
||
<h1 class="refname">gupnp_device_action_callback_set</h1>
|
||
<p class="verinfo">(PECL gupnp >= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_device_action_callback_set</span> — <span class="dc-title">Set device callback function</span></p>
|
||
|
||
</div>
|
||
|
||
<div class="refsect1 description" id="refsect1-function.gupnp-device-action-callback-set-description">
|
||
<h3 class="title">说明</h3>
|
||
<div class="methodsynopsis dc-description">
|
||
<span class="methodname"><strong>gupnp_device_action_callback_set</strong></span>
|
||
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$root_device</code></span>
|
||
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$signal</code></span>
|
||
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$action_name</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">
|
||
Set device callback function for signal and action.
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 parameters" id="refsect1-function.gupnp-device-action-callback-set-parameters">
|
||
<h3 class="title">参数</h3>
|
||
<p class="para">
|
||
<dl>
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">root_device</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
A root device identifier, returned by <span class="function"><a href="gupnp_root_device_new.html" class="function">gupnp_root_device_new()</a></span>.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">signal</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The value of signal. Signal can be one of the following values:
|
||
<dl>
|
||
|
||
|
||
<dt>
|
||
<strong><code>GUPNP_SIGNAL_ACTION_INVOKED</code></strong></dt>
|
||
|
||
<dd>
|
||
|
||
<span class="simpara">
|
||
Emitted whenever an action is invoked. Handler should process action
|
||
and must call either <span class="function"><a href="gupnp_service_action_return.html" class="function">gupnp_service_action_return()</a></span>
|
||
or <span class="function"><a href="gupnp_service_action_return_error.html" class="function">gupnp_service_action_return_error()</a></span>.
|
||
</span>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<strong><code>GUPNP_SIGNAL_NOTIFY_FAILED</code></strong></dt>
|
||
|
||
<dd>
|
||
|
||
<span class="simpara">
|
||
Emitted whenever notification of a client fails.
|
||
</span>
|
||
</dd>
|
||
|
||
|
||
</dl>
|
||
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">action_name</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The name of action.
|
||
</p>
|
||
</dd>
|
||
|
||
|
||
|
||
<dt>
|
||
<code class="parameter">callback</code></dt>
|
||
|
||
<dd>
|
||
|
||
<p class="para">
|
||
The callback function for the certain signal. Typically, callback function
|
||
takes on three parameters. The <code class="parameter">service</code> parameter's
|
||
identifier being the first, <code class="parameter">action</code> parameter's
|
||
identifier (in case GUPNP_SIGNAL_ACTION_INVOKED signal) or
|
||
<code class="parameter">error</code> parameter's message (in case GUPNP_SIGNAL_NOTIFY_FAILED
|
||
signal) 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-device-action-callback-set-returnvalues">
|
||
<h3 class="title">返回值</h3>
|
||
<p class="para">
|
||
成功时返回 <strong><code>TRUE</code></strong>， 或者在失败时返回 <strong><code>FALSE</code></strong>。
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 errors" id="refsect1-function.gupnp-device-action-callback-set-errors">
|
||
<h3 class="title">错误／异常</h3>
|
||
<p class="para">
|
||
Issues E_WARNING either with not valid callback function or with not valid signal.
|
||
</p>
|
||
</div>
|
||
|
||
|
||
<div class="refsect1 seealso" id="refsect1-function.gupnp-device-action-callback-set-seealso">
|
||
<h3 class="title">参见</h3>
|
||
<p class="para">
|
||
<ul class="simplelist">
|
||
<li class="member"><span class="function"><a href="gupnp_root_device_new.html" class="function" rel="rdfs-seeAlso">gupnp_root_device_new()</a> - Create a new root device</span></li>
|
||
</ul>
|
||
</p>
|
||
</div>
|
||
|
||
|
||
</div></div></div></body></html> |