derek Wed Jan 21 22:00:50 2004 EDT
Modified files:
/phpdoc/en/reference/sockets/functions socket-get-option.xml
Log:
Adding Documentation
http://cvs.php.net/diff.php/phpdoc/en/reference/sockets/functions/socket-get-option.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/sockets/functions/socket-get-option.xml
diff -u phpdoc/en/reference/sockets/functions/socket-get-option.xml:1.3
phpdoc/en/reference/sockets/functions/socket-get-option.xml:1.4
--- phpdoc/en/reference/sockets/functions/socket-get-option.xml:1.3 Thu May 2
04:31:38 2002
+++ phpdoc/en/reference/sockets/functions/socket-get-option.xml Wed Jan 21 22:00:49
2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/sockets.xml, last change in rev 1.27 -->
<refentry id="function.socket-get-option">
<refnamediv>
@@ -16,8 +16,132 @@
</methodsynopsis>
&warn.experimental.func;
<para>
- &warn.undocumented.func;
+ The <function>socket_get_option</function> function retrieves the value for
+ the option specified by the <parameter>optname</parameter> parameter for the
+ socket specified by the <parameter>socket</parameter> parameter.
<function>socket_get_option</function>
+ will return &false; on failure.
</para>
+ <para>
+ The <parameter>level</parameter> parameter specifies the protocol level at
+ which the option resides. For example, to retrieve options at the socket
level,
+ a <parameter>level</parameter> parameter of SOL_SOCKET would be used. Other
+ levels, such as TCP, can be used by specifying the protocol number of that
level.
+ Protocol numbers can be found by using the
<function>getprotobyname</function> function.
+ </para>
+ <table>
+ <title>Available Socket Options</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>SO_DEBUG</entry>
+ <entry>
+ Reports whether debugging information is being recorded.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_ACCEPTCONN</entry>
+ <entry>
+ Reports whether socket listening is enabled.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_BROADCAST</entry>
+ <entry>
+ Reports whether transmission of broadcast messages is supported.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_REUSEADDR</entry>
+ <entry>
+ Reports whether local addresses can be reused.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_KEEPALIVE</entry>
+ <entry>
+ Reports whether connections are kept active with periodic transmission
+ of messages. If the connected socket fails to respond to these
messages,
+ the connection is broken and processes writing to that socket are
notified
+ with a SIGPIPE signal.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_LINGER</entry>
+ <entry>
+ Reports whether the <parameter>socket</parameter> lingers on
<function>socket_close</function> if data is present.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_OOBINLINE</entry>
+ <entry>
+ Reports whether the <parameter>socket</parameter> leaves out-of-band
data inline.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_SNDBUF</entry>
+ <entry>
+ Reports send buffer size information.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_RCVBUF</entry>
+ <entry>
+ Reports recieve buffer size information.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_ERROR</entry>
+ <entry>
+ Reports information about error status and clears it.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_TYPE</entry>
+ <entry>
+ Reports the <parameter>socket</parameter> type.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_DONTROUTE</entry>
+ <entry>
+ Reports whether outgoing messages bypass the standard routing
facilities.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_RCVLOWAT</entry>
+ <entry>
+ Reports the minimum number of bytes to process for
<parameter>socket</parameter> input operations.
+ ( Defaults to 1 )
+ </entry>
+ </row>
+ <row>
+ <entry>SO_RCVTIMEO</entry>
+ <entry>
+ Reports the timeout value for input operations.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_SNDLOWAT</entry>
+ <entry>
+ Reports the minimum number of bytes to process for
<parameter>socket</parameter> output operations.
+ </entry>
+ </row>
+ <row>
+ <entry>SO_SNDTIMEO</entry>
+ <entry>
+ Reports the timeout value specifying the amount of time that an output
+ function blocks because flow control prevents data from being sent.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
<note>
<para>
This function used to be called <literal>socket_getopt()</literal> prior
