php-doc-en/reference/apd/functions/apd-set-socket-session-trace.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.apd-set-socket-session-trace" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>apd_set_socket_session_trace</refname>
  <refpurpose>Starts the remote session debugging</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>apd_set_socket_session_trace</methodname>
   <methodparam><type>string</type><parameter>tcp_server</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 specified <parameter>tcp_server</parameter> (eg. tcplisten)
   and sends debugging data to the socket. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>tcp_server</parameter></term>
     <listitem>
      <para>
       IP or Unix Domain socket (like a file) of the TCP server.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>socket_type</parameter></term>
     <listitem>
      <para>
       Can be <constant>AF_UNIX</constant> for file based sockets or 
       <constant>APD_AF_INET</constant> for standard tcp/ip.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>port</parameter></term>
     <listitem>
      <para>
       You can use any port, but higher numbers are better as most of the
       lower numbers may be used by other system services.
      </para>
     </listitem>
    </varlistentry>
    &apd.debug-level.description;
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <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
-->