diff --git a/reference/event/eventbase/free.xml b/reference/event/eventbase/free.xml new file mode 100644 index 0000000000..390cc7f5bf --- /dev/null +++ b/reference/event/eventbase/free.xml @@ -0,0 +1,73 @@ + + + + + EventBase::free + Free resources allocated for this event base + + + &reftitle.description; + + public + void + EventBase::free + + + + Deallocates resources allocated by libevent for the EventBase object. + + + + The + EventBase::free + method doesn't destruct the object itself. To destruct the + object completely call + unset + , or assign &null;. + + + This method does not deallocate or detach any of the events that are + currently associated with the EventBase object, or + close any of their sockets - beware. + + + + + &reftitle.parameters; + &no.function.parameters; + + + &reftitle.returnvalues; + + &return.void; + + + + &reftitle.seealso; + + + EventBase::__construct + + + + + diff --git a/reference/event/eventbufferevent/close.xml b/reference/event/eventbufferevent/close.xml new file mode 100644 index 0000000000..914426a1c6 --- /dev/null +++ b/reference/event/eventbufferevent/close.xml @@ -0,0 +1,54 @@ + + + + + EventBufferEvent::close + Closes file descriptor associated with the current buffer event + + + &reftitle.description; + + public + void + EventBufferEvent::close + + + + Closes file descriptor associated with the current buffer event. + + + This method may be used in cases when the + EventBufferEvent::OPT_CLOSE_ON_FREE option is not appropriate. + + + + &reftitle.parameters; + &no.function.parameters; + + + &reftitle.returnvalues; + + &return.void; + + + + diff --git a/reference/event/eventbufferevent/connect.xml b/reference/event/eventbufferevent/connect.xml index efbe155f59..db5d814a2d 100644 --- a/reference/event/eventbufferevent/connect.xml +++ b/reference/event/eventbufferevent/connect.xml @@ -42,14 +42,16 @@ Should contain an IP address with optional port number, or a path to UNIX domain socket. Recognized formats are: - + +]]> + Note, 'unix:' prefix is currently not case sensitive. diff --git a/reference/event/eventbufferevent/connecthost.xml b/reference/event/eventbufferevent/connecthost.xml index 02863bd5f1..dae098ec36 100644 --- a/reference/event/eventbufferevent/connecthost.xml +++ b/reference/event/eventbufferevent/connecthost.xml @@ -93,12 +93,14 @@ Hostname to connect to. Recognized formats are: - + +]]> + diff --git a/reference/event/eventbufferevent/sslgetcipherinfo.xml b/reference/event/eventbufferevent/sslgetcipherinfo.xml new file mode 100644 index 0000000000..c4ffa0476a --- /dev/null +++ b/reference/event/eventbufferevent/sslgetcipherinfo.xml @@ -0,0 +1,59 @@ + + + + + EventBufferEvent::sslGetCipherInfo + Returns a textual description of the cipher. + + + &reftitle.description; + + public + string + EventBufferEvent::sslGetCipherInfo + + + + Retrieves description of the current cipher by means of the + SSL_CIPHER_description SSL API function (see + SSL_CIPHER_get_name(3) man page). + + + + This function is available only if + Event + is compiled with OpenSSL support. + + + + + &reftitle.parameters; + &no.function.parameters; + + + &reftitle.returnvalues; + + Returns a textual description of the cipher on success, or &false; on error. + + + + diff --git a/reference/event/eventbufferevent/sslgetciphername.xml b/reference/event/eventbufferevent/sslgetciphername.xml new file mode 100644 index 0000000000..6099dbb0de --- /dev/null +++ b/reference/event/eventbufferevent/sslgetciphername.xml @@ -0,0 +1,57 @@ + + + + + EventBufferEvent::sslGetCipherName + Returns the current cipher name of the SSL connection. + + + &reftitle.description; + + public + string + EventBufferEvent::sslGetCipherName + + + + Retrieves name of cipher used by current SSL connection. + + + + This function is available only if + Event + is compiled with OpenSSL support. + + + + + &reftitle.parameters; + &no.function.parameters; + + + &reftitle.returnvalues; + + Returns the current cipher name of the SSL connection, or &false; on error. + + + + diff --git a/reference/event/eventbufferevent/sslgetcipherversion.xml b/reference/event/eventbufferevent/sslgetcipherversion.xml new file mode 100644 index 0000000000..83838538fa --- /dev/null +++ b/reference/event/eventbufferevent/sslgetcipherversion.xml @@ -0,0 +1,57 @@ + + + + + EventBufferEvent::sslGetCipherVersion + Returns version of cipher used by current SSL connection. + + + &reftitle.description; + + public + string + EventBufferEvent::sslGetCipherVersion + + + + Retrieves version of cipher used by current SSL connection. + + + + This function is available only if + Event + is compiled with OpenSSL support. + + + + + &reftitle.parameters; + &no.function.parameters; + + + &reftitle.returnvalues; + + Returns the current cipher version of the SSL connection, or &false; on error. + + + + diff --git a/reference/event/eventbufferevent/sslgetprotocol.xml b/reference/event/eventbufferevent/sslgetprotocol.xml new file mode 100644 index 0000000000..2a6fec4c0d --- /dev/null +++ b/reference/event/eventbufferevent/sslgetprotocol.xml @@ -0,0 +1,57 @@ + + + + + EventBufferEvent::sslGetProtocol + Returns the name of the protocol used for current SSL connection. + + + &reftitle.description; + + public + string + EventBufferEvent::sslGetProtocol + + + + Returns the name of the protocol used for current SSL connection. + + + + This function is available only if + Event + is compiled with OpenSSL support. + + + + + &reftitle.parameters; + &no.function.parameters; + + + &reftitle.returnvalues; + + Returns the name of the protocol used for current SSL connection. + + + + diff --git a/reference/event/examples.xml b/reference/event/examples.xml index 2677ef5051..18427d5846 100644 --- a/reference/event/examples.xml +++ b/reference/event/examples.xml @@ -770,7 +770,7 @@ HTTP/1.0 200 OK Content-Type: text/html; charset=ISO-8859-1 Connection: close ]]> - + Simple HTTPS server @@ -1014,7 +1014,7 @@ Body: PHP, date: 2013-03-13T20:27:52+05:00 ]]> - + diff --git a/reference/event/versions.xml b/reference/event/versions.xml index dcdbd010d3..5fc02869ec 100644 --- a/reference/event/versions.xml +++ b/reference/event/versions.xml @@ -23,6 +23,7 @@ <function name="event::delsignal" from="PECL event >= 1.2.6-beta"/> <function name='eventbase' from='PECL event >= 1.2.6-beta'/> <function name="eventbase::__construct" from="PECL event >= 1.2.6-beta"/> + <function name="eventbase::free" from="PECL event >= 1.10.0"/> <function name="eventbase::getmethod" from="PECL event >= 1.2.6-beta"/> <function name="eventbase::getfeatures" from="PECL event >= 1.2.6-beta"/> <function name="eventbase::priorityinit" from="PECL event >= 1.2.6-beta"/> @@ -41,6 +42,7 @@ <function name='eventbufferevent' from='PECL event >= 1.2.6-beta'/> <function name="eventbufferevent::__construct" from="PECL event >= 1.2.6-beta"/> <function name="eventbufferevent::free" from="PECL event >= 1.2.6-beta"/> + <function name="eventbufferevent::close" from="PECL event >= 1.10.0"/> <function name="eventbufferevent::connect" from="PECL event >= 1.2.6-beta"/> <function name="eventbufferevent::connecthost" from="PECL event >= 1.2.6-beta"/> <function name="eventbufferevent::getdnserrorstring" from="PECL event >= 1.2.6-beta"/> @@ -62,6 +64,10 @@ <function name="eventbufferevent::sslsocket" from="PECL event >= 1.2.6-beta"/> <function name="eventbufferevent::sslerror" from="PECL event >= 1.2.6-beta"/> <function name="eventbufferevent::sslrenegotiate" from="PECL event >= 1.2.6-beta"/> + <function name="eventbufferevent::sslgetcipherinfo" from="PECL event >= 1.10.0"/> + <function name="eventbufferevent::sslgetciphername" from="PECL event >= 1.10.0"/> + <function name="eventbufferevent::sslgetcipherversion" from="PECL event >= 1.10.0"/> + <function name="eventbufferevent::sslgetprotocol" from="PECL event >= 1.10.0"/> <function name='eventbuffer' from='PECL event >= 1.5.0'/> <function name="eventbuffer::__construct" from="PECL event >= 1.2.6-beta"/> <function name="eventbuffer::freeze" from="PECL event >= 1.2.6-beta"/>