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
141
142
143
144
145
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 331238 $ -->
<refentry xml:id="eventbufferevent.sslsocket" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>EventBufferEvent::sslSocket</refname>
<refpurpose>Creates a new SSL buffer event to send its data over an SSL on a socket</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<modifier>static</modifier>
<type>EventBufferEvent</type>
<methodname>EventBufferEvent::sslSocket</methodname>
<methodparam>
<type>EventBase</type>
<parameter>base</parameter>
</methodparam>
<methodparam>
<type>mixed</type>
<parameter>socket</parameter>
</methodparam>
<methodparam>
<type>EventSslContext</type>
<parameter>ctx</parameter>
</methodparam>
<methodparam>
<type>int</type>
<parameter>state</parameter>
</methodparam>
<methodparam choice="opt">
<type>int</type>
<parameter>options</parameter>
</methodparam>
</methodsynopsis>
<para>
Creates a new SSL buffer event to send its data over an SSL on a socket.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term>
<parameter>base</parameter>
</term>
<listitem>
<para>
Associated event base.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>socket</parameter>
</term>
<listitem>
<para>
Socket to use for this SSL. Can be stream or socket resource, numeric
file descriptor, or &null;. If
<parameter>socket</parameter>
is &null;, it is assumed that the file descriptor for the socket will be
assigned later, for instance, by means of
<methodname>EventBufferEvent::connectHost</methodname>
method.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>ctx</parameter>
</term>
<listitem>
<para>
Object of
<classname>EventSslContext</classname>
class.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>state</parameter>
</term>
<listitem>
<para>
The current state of SSL connection:
<constant>EventBufferEvent::SSL_OPEN</constant>
,
<constant>EventBufferEvent::SSL_ACCEPTING</constant>
or
<constant>EventBufferEvent::SSL_CONNECTING</constant>
.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>options</parameter>
</term>
<listitem>
<para>
The buffer event options.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns
<classname>EventBufferEvent</classname>
object.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member>
<methodname>EventBufferEvent::sslFilter</methodname>
</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
-->
|
