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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 329987 $ -->
<refentry xml:id="eventutil.setsocketoption" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventUtil::setSocketOption</refname>
<refpurpose>Sets socket options</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<modifier>static</modifier>
<type>bool</type>
<methodname>EventUtil::setSocketOption</methodname>
<methodparam>
<type>mixed</type>
<parameter>socket</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>level</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>optname</parameter>
</methodparam>
<methodparam>
<type>mixed</type>
<parameter>optval</parameter>
</methodparam>
</methodsynopsis>
<para>
Sets socket options.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>socket</parameter>
</term>
<listitem>
<para>
Socket resource, stream, or numeric file descriptor associated with the
socket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>level</parameter>
</term>
<listitem>
<para>
One of
<literal>EventUtil::SOL_*</literal>
constants. Specifies the protocol level at which the option resides. For
example, to retrieve options at the socket level, a
<parameter>level</parameter>
parameter of
<constant>EventUtil::SOL_SOCKET</constant>
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. See
<link linkend="eventutil.constants">EventUtil constants</link>
.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>optname</parameter>
</term>
<listitem>
<para>
Option name(type). Has the same meaning as corresponding parameter of
<function>socket_get_option</function>
function. See
<link linkend="eventutil.constants">EventUtil constants</link>
.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>optval</parameter>
</term>
<listitem>
<para>
Accepts the same values as
<parameter>optval</parameter>
parameter of the
<function>socket_get_option</function>
function.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success. Otherwise &false;.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<function>socket_get_option</function>
</member>
<member>
<function>socket_set_option</function>
</member>
</simplelist>
</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
-->
|
