construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="eventsslcontext.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>EventSslContext::__construct</refname>
  <refpurpose>Constructs an OpenSSL context for use with Event classes</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier>
   <methodname>EventSslContext::__construct</methodname>
   <methodparam>
    <type>string</type>
    <parameter>method</parameter>
   </methodparam>
   <methodparam>
    <type>string</type>
    <parameter>options</parameter>
   </methodparam>
  </methodsynopsis>
  <para>
   Creates SSL context holding pointer to
   <literal>SSL_CTX</literal>
   (see the system manual).
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term>
     <parameter>method</parameter>
    </term>
    <listitem>
     <para>
      One of
      <link linkend="eventsslcontext.constants">
       <literal>EventSslContext::*_METHOD</literal> constants</link>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>options</parameter>
    </term>
    <listitem>
     <para>
      Associative array of SSL context options One of
      <link
     linkend="eventsslcontext.constants">
       <literal>EventSslContext::OPT_*</literal> constants</link>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>
    <function>EventSslContext::__construct</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$ctx = new EventSslContext(EventSslContext::SSLv3_SERVER_METHOD, array(
     EventSslContext::OPT_LOCAL_CERT        => $local_cert,
     EventSslContext::OPT_LOCAL_PK          => $local_pk,
     EventSslContext::OPT_PASSPHRASE        => "echo server",
     EventSslContext::OPT_VERIFY_PEER       => true,
     EventSslContext::OPT_ALLOW_SELF_SIGNED => false,
));
?>
]]>
   </programlisting>
  </example>
 </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
-->