<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventbufferevent.sslfilter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude">
 <refnamediv>
  <refname>EventBufferEvent::sslFilter</refname>
  <refpurpose>Create a new SSL buffer event to send its data over another buffer event</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier>
   <modifier>static</modifier>
   <type>EventBufferEvent</type>
   <methodname>EventBufferEvent::sslFilter</methodname>
   <methodparam>
    <type>EventBase</type>
    <parameter>base</parameter>
   </methodparam>
   <methodparam>
    <type>EventBufferEvent</type>
    <parameter>underlying</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>
    <initializer>0</initializer>
   </methodparam>
  </methodsynopsis>
  <para>
   Create a new SSL buffer event to send its data over another buffer event
  </para>
  <note>
   <para>
    This function is available only if
    <literal>Event</literal>
    is compiled with OpenSSL support.
   </para>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term>
     <parameter>base</parameter>
    </term>
    <listitem>
     <para>
      Associated event base.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>underlying</parameter>
    </term>
    <listitem>
     <para>
      A socket buffer event to use for this SSL.
     </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>
      One or more buffer event options.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a new SSL
   <classname>EventBufferEvent</classname>
   object.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
                          xpointer(id('event.example.smtp')/*)" />
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member>
    <methodname>EventBufferEvent::sslSocket</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
-->
