php-doc-en/reference/sockets/functions/socket-send.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.9 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-send">
 <refnamediv>
  <refname>socket_send</refname>
  <refpurpose>Sends data to a connected socket</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>int</type><methodname>socket_send</methodname>
   <methodparam><type>resource</type><parameter>socket</parameter></methodparam>
   <methodparam><type>string</type><parameter>buf</parameter></methodparam>
   <methodparam><type>int</type><parameter>len</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
  </methodsynopsis>
  <para>
   The function <function>socket_send</function> sends
   <parameter>len</parameter> bytes to the socket
   <parameter>socket</parameter> from <parameter>buf</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>socket</parameter></term>
     <listitem>
      <para>
       A valid socket resource created with <function>socket_create</function>
       or <function>socket_accept</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>buf</parameter></term>
     <listitem>
      <para>
       A buffer containing the data that will be sent to the remote host.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>len</parameter></term>
     <listitem>
      <para>
       The number of bytes that will be sent to the remote host from 
       <parameter>buf</parameter>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>flags</parameter></term>
     <listitem>
      <para>
       The value of <parameter>flags</parameter> can be any
       <literal>ORed</literal> combination of the following:
       <table>
        <title>possible values for <parameter>flags</parameter></title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>MSG_OOB</constant></entry>
           <entry>
            Process OOB (out-of-band) data
           </entry>
          </row>
          <row>
           <entry><constant>MSG_PEEK</constant></entry>
           <entry>
            Peek at incoming message
           </entry>
          </row>
          <row>
           <entry><constant>MSG_DONTROUTE</constant></entry>
           <entry>
            Bypass routing, use direct interface
           </entry>
          </row>
          <row>
           <entry><constant>MSG_EOR</constant></entry>
           <entry>
            Data completes record
           </entry>
          </row>
          <row>
           <entry><constant>MSG_EOF</constant></entry>
           <entry>
            Data completes transaction
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

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

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>socket_sendto</function></member>
   </simplelist>
  </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
-->