php-doc-en/reference/apd/functions/apd-set-socket-session-trace.xml
2004-11-23 09:38:18 +00:00

84 lines
2.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/apd.xml, last change in rev 1.4 -->
<refentry id="function.apd-set-socket-session-trace">
<refnamediv>
<refname>apd_set_socket_session_trace</refname>
<refpurpose>Starts the remote session debugging</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>apd_set_socket_session_trace</methodname>
<methodparam><type>string</type><parameter>ip_address_or_unix_socket_file</parameter></methodparam>
<methodparam><type>int</type><parameter>socket_type</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
<methodparam><type>int</type><parameter>debug_level</parameter></methodparam>
</methodsynopsis>
<para>
Connects to the tcp server (eg. tcplisten) specified IP or Unix Domain
socket (like a file), and sends debugging data to the socket. You can
use any port, but higher numbers are better as most of the lower numbers
may be used by other system services.
</para>
<para>
the socket_type can be APD_AF_UNIX (for file based sockets) or APD_AF_INET
(for standard tcp/ip)
</para>
<para>
debug_level is an integer which is formed by adding together the following
values:
</para>
<para>
<programlisting role="script">
<![CDATA[
FUNCTION_TRACE 1
ARGS_TRACE 2
ASSIGNMENT_TRACE 4
STATEMENT_TRACE 8
MEMORY_TRACE 16
TIMING_TRACE 32
SUMMARY_TRACE 64
]]>
</programlisting>
</para>
<para>
I would seriously not recommend setting the value to 'zero' to start with,
and use the breakpoint methods to start debugging at a specific place in
the file.
</para>
<para>
<example>
<title><function>apd_set_socket_session_trace</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
apd_set_socket_session_trace("127.0.0.1",APD_AF_INET,7112,0);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->