mirror of
https://github.com/php/doc-en.git
synced 2026-03-23 23:32:18 +01:00
144 lines
3.5 KiB
XML
144 lines
3.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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
|
|
-->
|