mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 10:58:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
273 lines
8.8 KiB
XML
273 lines
8.8 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.socket-create">
|
|
<refnamediv>
|
|
<refname>socket_create</refname>
|
|
<refpurpose>Create a socket (endpoint for communication)</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>resource</type><methodname>socket_create</methodname>
|
|
<methodparam><type>int</type><parameter>domain</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>type</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>protocol</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Creates and returns a socket resource, also referred to as an endpoint
|
|
of communication. A typical network connection is made up of 2 sockets, one
|
|
performing the role of the client, and another performing the role of the server.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>domain</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>domain</parameter> parameter specifies the protocol
|
|
family to be used by the socket.
|
|
</para>
|
|
<table>
|
|
<title>Available address/protocol families</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Domain</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry><constant>AF_INET</constant></entry>
|
|
<entry>
|
|
IPv4 Internet based protocols. TCP and UDP are common protocols of
|
|
this protocol family.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>AF_INET6</constant></entry>
|
|
<entry>
|
|
IPv6 Internet based protocols. TCP and UDP are common protocols of
|
|
this protocol family.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>AF_UNIX</constant></entry>
|
|
<entry>
|
|
Local communication protocol family. High efficiency and low
|
|
overhead make it a great form of IPC (Interprocess Communication).
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>type</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>type</parameter> parameter selects the type of communication
|
|
to be used by the socket.
|
|
</para>
|
|
<table>
|
|
<title>Available socket types</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Type</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry><constant>SOCK_STREAM</constant></entry>
|
|
<entry>
|
|
Provides sequenced, reliable, full-duplex, connection-based byte streams.
|
|
An out-of-band data transmission mechanism may be supported.
|
|
The TCP protocol is based on this socket type.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>SOCK_DGRAM</constant></entry>
|
|
<entry>
|
|
Supports datagrams (connectionless, unreliable messages of a fixed maximum length).
|
|
The UDP protocol is based on this socket type.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>SOCK_SEQPACKET</constant></entry>
|
|
<entry>
|
|
Provides a sequenced, reliable, two-way connection-based data transmission path for
|
|
datagrams of fixed maximum length; a consumer is required to read an
|
|
entire packet with each read call.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>SOCK_RAW</constant></entry>
|
|
<entry>
|
|
Provides raw network protocol access. This special type of socket
|
|
can be used to manually construct any type of protocol. A common use
|
|
for this socket type is to perform ICMP requests (like ping).
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>SOCK_RDM</constant></entry>
|
|
<entry>
|
|
Provides a reliable datagram layer that does not guarantee ordering.
|
|
This is most likely not implemented on your operating system.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>protocol</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The <parameter>protocol</parameter> parameter sets the specific
|
|
protocol within the specified <parameter>domain</parameter> to be used
|
|
when communicating on the returned socket. The proper value can be
|
|
retrieved by name by using <function>getprotobyname</function>. If
|
|
the desired protocol is TCP, or UDP the corresponding constants
|
|
<constant>SOL_TCP</constant>, and <constant>SOL_UDP</constant>
|
|
can also be used.
|
|
</para>
|
|
<table>
|
|
<title>Common protocols</title>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>Name</entry>
|
|
<entry>Description</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>icmp</entry>
|
|
<entry>
|
|
The Internet Control Message Protocol is used primarily by gateways
|
|
and hosts to report errors in datagram communication. The "ping"
|
|
command (present in most modern operating systems) is an example
|
|
application of ICMP.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>udp</entry>
|
|
<entry>
|
|
The User Datagram Protocol is a connectionless, unreliable,
|
|
protocol with fixed record lengths. Due to these aspects, UDP
|
|
requires a minimum amount of protocol overhead.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry>tcp</entry>
|
|
<entry>
|
|
The Transmission Control Protocol is a reliable, connection based,
|
|
stream oriented, full duplex protocol. TCP guarantees that all data packets
|
|
will be received in the order in which they were sent. If any packet is somehow
|
|
lost during communication, TCP will automatically retransmit the packet until
|
|
the destination host acknowledges that packet. For reliability and performance
|
|
reasons, the TCP implementation itself decides the appropriate octet boundaries
|
|
of the underlying datagram communication layer. Therefore, TCP applications must
|
|
allow for the possibility of partial record transmission.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
<function>socket_create</function> returns a 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>
|
|
</refsect1>
|
|
|
|
<refsect1 role="changelog">
|
|
&reftitle.changelog;
|
|
<para>
|
|
<informaltable>
|
|
<tgroup cols="2">
|
|
<thead>
|
|
<row>
|
|
<entry>&Version;</entry>
|
|
<entry>&Description;</entry>
|
|
</row>
|
|
</thead>
|
|
<tbody>
|
|
<row>
|
|
<entry>5.0.0</entry>
|
|
<entry>
|
|
The <constant>AF_INET6</constant> constant was added.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</informaltable>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
If an invalid <parameter>domain</parameter> or
|
|
<parameter>type</parameter> is given, <function>socket_create</function>
|
|
defaults to <constant>AF_INET</constant> and
|
|
<constant>SOCK_STREAM</constant> respectively and additionally emits an
|
|
<constant>E_WARNING</constant> message.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>socket_accept</function></member>
|
|
<member><function>socket_bind</function></member>
|
|
<member><function>socket_connect</function></member>
|
|
<member><function>socket_listen</function></member>
|
|
<member><function>socket_last_error</function></member>
|
|
<member><function>socket_strerror</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:"~/.phpdoc/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
|
|
-->
|