Source of: /manual/en/function.apd-set-session-trace-socket.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.apd.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'function.apd-set-session-trace-socket.php',
1 => 'apd_set_session_trace_socket',
),
'up' =>
array (
0 => 'ref.apd.php',
1 => 'APD Functions',
),
'prev' =>
array (
0 => 'function.apd-set-pprof-trace.php',
1 => 'apd_set_pprof_trace',
),
'next' =>
array (
0 => 'function.apd-set-session-trace.php',
1 => 'apd_set_session_trace',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="function.apd-set-session-trace-socket" class="refentry">
<div class="refnamediv">
<h1 class="refname">apd_set_session_trace_socket</h1>
<p class="verinfo">(PECL apd >= 0.2)</p><p class="refpurpose"><span class="refname">apd_set_session_trace_socket</span> — <span class="dc-title">Starts the remote session debugging</span></p>
</div>
<a name="function.apd-set-session-trace-socket.description"></a><div class="refsect1 description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>apd_set_session_trace_socket</b></span>
( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$tcp_server</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$socket_type</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$port</tt></span>
, <span class="methodparam"><span class="type">int</span> <tt class="parameter">$debug_level</tt></span>
)</div>
<p class="para rdfs-comment">
Connects to the specified <i><tt class="parameter">tcp_server</tt></i>
(eg. tcplisten)
and sends debugging data to the socket.
</p>
</div>
<a name="function.apd-set-session-trace-socket.parameters"></a><div class="refsect1 parameters">
<h3 class="title">Parameters</h3>
<p class="para">
</p><dl>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">tcp_server</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
IP or Unix Domain socket (like a file) of the TCP server.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">socket_type</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
Can be <b><tt class="constant">AF_UNIX</tt></b> for file based sockets or
<b><tt class="constant">APD_AF_INET</tt></b> for standard tcp/ip.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">port</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">
You can use any port, but higher numbers are better as most of the
lower numbers may be used by other system services.
</p>
</dd>
<dt class="varlistentry">
<span class="term"><i><tt class="parameter">
debug_level</tt></i>
</span>
</dt><dd class="listitem">
<p class="para">An integer which is formed by adding
together the <i>XXX_TRACE</i> constants.</p><p class="para">It is not recommended
to use <b><tt class="constant">MEMORY_TRACE</tt></b>. It is very slow and does not appear to be accurate.
<b><tt class="constant">ASSIGNMENT_TRACE</tt></b> is not implemented yet.</p><p class="para">To turn on all
functional traces (TIMING, FUNCTIONS, ARGS SUMMARY (like strace -c)) use the value 99</p>
</dd>
</dl>
<p>
</p>
</div>
<a name="function.apd-set-session-trace-socket.returnvalues"></a><div class="refsect1 returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt class="constant">TRUE</tt></b> on success or <b><tt class="constant">FALSE</tt></b> on failure.
</p>
</div>
<a name="function.apd-set-session-trace-socket.examples"></a><div class="refsect1 examples">
<h3 class="title">Examples</h3>
<p class="para">
</p><div class="example">
<p><b>Example #1 <b>apd_set_session_trace_socket()</b> example</b></p>
<div class="example-contents programlisting">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> apd_set_session_trace_socket</span><span style="color: #007700">(</span><span style="color: #DD0000">"127.0.0.1"</span><span style="color: #007700">,</span><span style="color: #0000BB">APD_AF_INET</span><span style="color: #007700">,</span><span style="color: #0000BB">7112</span><span style="color: #007700">,</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div><p>
</p>
</div>
</div><?php manual_footer(); ?>
