[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/event/eventbufferevent/_read.xml_settimeouts.xml
From:       Ruslan_Osmanov <osmanov () php ! net>
Date:       2014-02-15 20:21:07
Message-ID: svn-osmanov-1392495667-332860-322862167 () svn ! php ! net
[Download RAW message or body]

osmanov                                  Sat, 15 Feb 2014 20:21:07 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=332860

Log:
Fix: EventBufferEvent::sslError, EventBufferEvent::setTimeouts and EventBufferEvent::read proto

Changed paths:
    U   phpdoc/en/trunk/reference/event/eventbufferevent/read.xml
    U   phpdoc/en/trunk/reference/event/eventbufferevent/settimeouts.xml
    U   phpdoc/en/trunk/reference/event/eventbufferevent/sslerror.xml

Modified: phpdoc/en/trunk/reference/event/eventbufferevent/read.xml
===================================================================
--- phpdoc/en/trunk/reference/event/eventbufferevent/read.xml	2014-02-15 07:47:10 UTC (rev 332859)
+++ phpdoc/en/trunk/reference/event/eventbufferevent/read.xml	2014-02-15 20:21:07 UTC (rev 332860)
@@ -9,13 +9,9 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier>
-   <type>int</type>
+   <type>string</type>
    <methodname>EventBufferEvent::read</methodname>
    <methodparam>
-    <type>string</type>
-    <parameter role="reference">data</parameter>
-   </methodparam>
-   <methodparam>
     <type>int</type>
     <parameter>size</parameter>
    </methodparam>
@@ -23,9 +19,7 @@
   <para>
    Removes up to
    <parameter>size</parameter>
-   bytes from the input buffer, storing them into
-   <parameter>data</parameter>
-   .
+   bytes from the input buffer. Returns a string of data read from the input buffer.
   </para>
  </refsect1>
  <refsect1 role="parameters">
@@ -33,21 +27,11 @@
   <variablelist>
    <varlistentry>
     <term>
-     <parameter>data</parameter>
-    </term>
-    <listitem>
-     <para>
-      Storage for the read data.
-     </para>
-    </listitem>
-   </varlistentry>
-   <varlistentry>
-    <term>
      <parameter>size</parameter>
     </term>
     <listitem>
      <para>
-      Maximum numbe rof bytes to read
+      Maximum number of bytes to read
      </para>
     </listitem>
    </varlistentry>
@@ -56,7 +40,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns the number of bytes actually removed.
+   Returns string of data read from the input buffer.
   </para>
  </refsect1>
  <refsect1 role="seealso">

Modified: phpdoc/en/trunk/reference/event/eventbufferevent/settimeouts.xml
===================================================================
--- phpdoc/en/trunk/reference/event/eventbufferevent/settimeouts.xml	2014-02-15 07:47:10 UTC (rev 332859)
+++ phpdoc/en/trunk/reference/event/eventbufferevent/settimeouts.xml	2014-02-15 20:21:07 UTC (rev 332860)
@@ -12,11 +12,11 @@
    <type>bool</type>
    <methodname>EventBufferEvent::setTimeouts</methodname>
    <methodparam>
-    <type>int</type>
+    <type>float</type>
     <parameter>timeout_read</parameter>
    </methodparam>
    <methodparam>
-    <type>int</type>
+    <type>float</type>
     <parameter>timeout_write</parameter>
    </methodparam>
   </methodsynopsis>

Modified: phpdoc/en/trunk/reference/event/eventbufferevent/sslerror.xml
===================================================================
--- phpdoc/en/trunk/reference/event/eventbufferevent/sslerror.xml	2014-02-15 07:47:10 UTC (rev 332859)
+++ phpdoc/en/trunk/reference/event/eventbufferevent/sslerror.xml	2014-02-15 20:21:07 UTC (rev 332860)
@@ -9,7 +9,7 @@
   &reftitle.description;
   <methodsynopsis>
    <modifier>public</modifier>
-   <type>void</type>
+   <type>string</type>
    <methodname>EventBufferEvent::sslError</methodname>
    <void />
   </methodsynopsis>
@@ -31,7 +31,8 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns &false;, if there is no more error to return.
+   Returns OpenSSL error string reported on the buffer event,
+   or &false;, if there is no more error to return.
   </para>
  </refsect1>
  <refsect1 role="examples">



-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]