File: socket-accept.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (74 lines) | stat: -rw-r--r-- 2,738 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/sockets.xml, last change in rev 1.1 -->
  <refentry id="function.socket-accept">
   <refnamediv>
    <refname>socket_accept</refname>
    <refpurpose>Accepts a connection on a socket</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>resource</type><methodname>socket_accept</methodname>
      <methodparam><type>resource</type><parameter>socket</parameter></methodparam>
     </methodsynopsis>
    <para>
     After the socket <parameter>socket</parameter> has been created
     using <function>socket_create</function>, bound to a name with
     <function>socket_bind</function>, and told to listen for connections
     with <function>socket_listen</function>, this function will accept
     incoming connections on that socket. Once a successful connection
     is made, a new socket resource is returned, which may be used
     for communication. If there are multiple connections queued on
     the socket, the first will be used. If there are no pending
     connections, <function>socket_accept</function> will block until
     a connection becomes present. If <parameter>socket</parameter>
     has been made non-blocking using
     <function>socket_set_blocking</function> or
     <function>socket_set_nonblock</function>, &false; will be returned.
    </para>
    <para>
     The socket resource returned by
     <function>socket_accept</function> may not be used to accept new
     connections. The original listening socket
     <parameter>socket</parameter>, however, remains open and may be
     reused.
    </para>
    <para>
     Returns a new socket resource on success, or &false; on error. The actual
     error code can be retrieved by calling
     <function>socket_last_error</function>. This error code may be passed to
     <function>socket_strerror</function> to get a textual explanation of the
     error.
    </para>
    <para>
     See also 
     <function>socket_bind</function>,
     <function>socket_connect</function>,
     <function>socket_listen</function>,
     <function>socket_create</function>, and
     <function>socket_strerror</function>.
    </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
-->