<!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>Starts the remote session debugging</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apd-set-pprof-trace.html">apd_set_pprof_trace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apd-set-session-trace.html">apd_set_session_trace</a></div>
<div class="up"><a href="ref.apd.html">APD Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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>
<div class="refsect1 description" id="refsect1-function.apd-set-session-trace-socket-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>apd_set_session_trace_socket</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$tcp_server</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$socket_type</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$port</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$debug_level</code></span>
)</div>
<p class="para rdfs-comment">
Connects to the specified <em><code class="parameter">tcp_server</code></em> (eg. <em>tcplisten</em>)
and sends debugging data to the socket.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.apd-set-session-trace-socket-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">tcp_server</code></em></span>
<dd>
<p class="para">
IP or Unix Domain socket (like a file) of the TCP server.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">socket_type</code></em></span>
<dd>
<p class="para">
Can be <strong><code>AF_UNIX</code></strong> for file based sockets or
<strong><code>APD_AF_INET</code></strong> for standard tcp/ip.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">port</code></em></span>
<dd>
<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>
<dt>
<span class="term"><em><code class="parameter">
debug_level</code></em></span><dd>
<p class="para">An integer which is formed by adding
together the <em>XXX_TRACE</em> constants.</p><p class="para">It is not recommended
to use <strong><code>MEMORY_TRACE</code></strong>. It is very slow and does not appear to be accurate.
<strong><code>ASSIGNMENT_TRACE</code></strong> 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>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.apd-set-session-trace-socket-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.apd-set-session-trace-socket-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-430">
<p><strong>Example #1 <span class="function"><strong>apd_set_session_trace_socket()</strong></span> example</strong></p>
<div class="example-contents">
<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>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.apd-set-pprof-trace.html">apd_set_pprof_trace</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.apd-set-session-trace.html">apd_set_session_trace</a></div>
<div class="up"><a href="ref.apd.html">APD Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
