<!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 a function to be called at regular intervals</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.gupnp-context-set-subscription-timeout.html">gupnp_context_set_subscription_timeout</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.gupnp-context-unhost-path.html">gupnp_context_unhost_path</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-context-timeout-add" class="refentry"> <div class="refnamediv"> <h1 class="refname">gupnp_context_timeout_add</h1> <p class="verinfo">(PECL gupnp >= 0.1.0)</p><p class="refpurpose"><span class="refname">gupnp_context_timeout_add</span> — <span class="dc-title">Sets a function to be called at regular intervals</span></p> </div> <div class="refsect1 description" id="refsect1-function.gupnp-context-timeout-add-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>gupnp_context_timeout_add</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$context</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$timeout</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"> Sets a function to be called at regular intervals. </p> </div> <div class="refsect1 parameters" id="refsect1-function.gupnp-context-timeout-add-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">context</code></em></span> <dd> <p class="para"> A context identifier, returned by <span class="function"><a href="function.gupnp-context-new.html" class="function">gupnp_context_new()</a></span>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">timeout</code></em></span> <dd> <p class="para"> A timeout in miliseconds. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">callback</code></em></span> <dd> <p class="para"> The callback function calling every <em><code class="parameter">timeout</code></em> period of time. Typically, callback function takes on <em><code class="parameter">arg</code></em> parameter. </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-context-timeout-add-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 examples" id="refsect1-function.gupnp-context-timeout-add-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4344"> <p><strong>Example #1 Create new UPnP context and set callback</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$user_data </span><span style="color: #007700">= </span><span style="color: #DD0000">"user data"</span><span style="color: #007700">;<br /><br />function </span><span style="color: #0000BB">timeout_cb</span><span style="color: #007700">(</span><span style="color: #0000BB">$arg</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"Call timeout_cb, user data: '%s'"</span><span style="color: #007700">, </span><span style="color: #0000BB">$arg</span><span style="color: #007700">);<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">/* Create the UPnP context */<br /></span><span style="color: #0000BB">$context </span><span style="color: #007700">= </span><span style="color: #0000BB">gupnp_context_new</span><span style="color: #007700">();<br /><br />if (!</span><span style="color: #0000BB">$context</span><span style="color: #007700">) {<br /> die(</span><span style="color: #DD0000">"Error creating the GUPnP context\n"</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #FF8000">/* Create root device */<br /></span><span style="color: #0000BB">$dev </span><span style="color: #007700">= </span><span style="color: #0000BB">gupnp_root_device_new</span><span style="color: #007700">(</span><span style="color: #0000BB">$context</span><span style="color: #007700">, </span><span style="color: #DD0000">"/devicedesc.xml"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Set callback for timeout */<br /></span><span style="color: #0000BB">gupnp_context_timeout_add</span><span style="color: #007700">(</span><span style="color: #0000BB">$context</span><span style="color: #007700">, </span><span style="color: #0000BB">5000</span><span style="color: #007700">, </span><span style="color: #DD0000">"timeout_cb"</span><span style="color: #007700">, </span><span style="color: #0000BB">$user_data</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* Run the main loop */<br /></span><span style="color: #0000BB">gupnp_root_device_start</span><span style="color: #007700">(</span><span style="color: #0000BB">$dev</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 errors" id="refsect1-function.gupnp-context-timeout-add-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> Issues E_WARNING with not valid callback function. </p> </div> <div class="refsect1 seealso" id="refsect1-function.gupnp-context-timeout-add-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.gupnp-context-new.html" class="function" rel="rdfs-seeAlso">gupnp_context_new()</a> - Create a new context</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-context-set-subscription-timeout.html">gupnp_context_set_subscription_timeout</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.gupnp-context-unhost-path.html">gupnp_context_unhost_path</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>