<!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><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-control-point-new.html">gupnp_control_point_new</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-device-info-get-service.html">gupnp_device_info_get_service</a></div>
<div class="up"><a href="ref.gupnp.html">Gupnp Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <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>
] )</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">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">root_device</code></em></span>
<dd>
<p class="para">
A root device identifier, returned by <span class="function"><a href="function.gupnp-root-device-new.html" class="function">gupnp_root_device_new()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">signal</code></em></span>
<dd>
<p class="para">
The value of signal. Signal can be one of the following values:
<dl>
<dt>
<span class="term"><strong><code>GUPNP_SIGNAL_ACTION_INVOKED</code></strong></span>
<dd>
<span class="simpara">
Emitted whenever an action is invoked. Handler should process action
and must call either <span class="function"><a href="function.gupnp-service-action-return.html" class="function">gupnp_service_action_return()</a></span>
or <span class="function"><a href="function.gupnp-service-action-return-error.html" class="function">gupnp_service_action_return_error()</a></span>.
</span>
</dd>
</dt>
<dt>
<span class="term"><strong><code>GUPNP_SIGNAL_NOTIFY_FAILED</code></strong></span>
<dd>
<span class="simpara">
Emitted whenever notification of a client fails.
</span>
</dd>
</dt>
</dl>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">action_name</code></em></span>
<dd>
<p class="para">
The name of action.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">callback</code></em></span>
<dd>
<p class="para">
The callback function for the certain signal. Typically, callback function
takes on three parameters. The <em><code class="parameter">service</code></em> parameter's
identifier being the first, <em><code class="parameter">action</code></em> parameter's
identifier (in case GUPNP_SIGNAL_ACTION_INVOKED signal) or
<em><code class="parameter">error</code></em> parameter's message (in case GUPNP_SIGNAL_NOTIFY_FAILED
signal) being the second, and the <em><code class="parameter">arg</code></em> is third.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">arg</code></em></span>
<dd>
<p class="para">
User data for <em><code class="parameter">callback</code></em>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.gupnp-device-action-callback-set-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.gupnp-device-action-callback-set-errors">
<h3 class="title">Errors/Exceptions</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">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.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><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-control-point-new.html">gupnp_control_point_new</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.gupnp-device-info-get-service.html">gupnp_device_info_get_service</a></div>
<div class="up"><a href="ref.gupnp.html">Gupnp Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
