RubyGems - passenger - Versions diffs - 3.0.0.pre2 → 3.0.0.pre3 - Mend

passenger 3.0.0.pre2 → 3.0.0.pre3

Potentially problematic release.

This version of passenger might be problematic. Click here for more details.

Files changed (182) hide show

data/doc/rdoc/classes/PhusionPassenger/NativeSupport.html DELETED

@@ -1,494 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html>
-  <head>
-    <title>Module: PhusionPassenger::NativeSupport</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-    <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-    <script language="JavaScript" type="text/javascript">
-    // <![CDATA[
-        function toggleSource( id )
-        {
-          var elem
-          var link
-          if( document.getElementById )
-          {
-            elem = document.getElementById( id )
-            link = document.getElementById( "l_" + id )
-          }
-          else if ( document.all )
-          {
-            elem = eval( "document.all." + id )
-            link = eval( "document.all.l_" + id )
-          }
-          else
-            return false;
-          if( elem.style.display == "block" )
-          {
-            elem.style.display = "none"
-            link.innerHTML = "show source"
-          }
-          else
-          {
-            elem.style.display = "block"
-            link.innerHTML = "hide source"
-          }
-        }
-        function openCode( url )
-        {
-          window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
-        }
-      // ]]>
-    </script>
-  </head>
-  <body>
-  <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
-  <td class="file-title"><span class="file-title-prefix">Module</span><br />PhusionPassenger::NativeSupport</td>
-  <td align="right">
-    <table cellspacing="0" cellpadding="2">
-      <tr valign="top">
-        <td>In:</td>
-        <td>
-<a href="../../files/ext/phusion_passenger/native_support_c.html">ext/phusion_passenger/native_support.c</a>
-        </td>
-      </tr>
-         </table>
-        </td>
-        </tr>
-      </table>
- <!-- banner header -->
-  <div id="bodyContent">
-      <div id="content">
-  <div class="description"><p>
-Utility functions for accessing system functionality.
-</p>
-</div>
-  <div class="sectiontitle">Methods</div>
-  <ul>
-  <li><a href="#M000031">close_all_file_descriptors</a></li>
-  <li><a href="#M000030">create_unix_socket</a></li>
-  <li><a href="#M000032">disable_stdio_buffering</a></li>
-  <li><a href="#M000029">recv_fd</a></li>
-  <li><a href="#M000028">send_fd</a></li>
-  <li><a href="#M000033">split_by_null_into_hash</a></li>
-  <li><a href="#M000037">switch_user</a></li>
-  <li><a href="#M000034">writev</a></li>
-  <li><a href="#M000035">writev2</a></li>
-  <li><a href="#M000036">writev3</a></li>
-  </ul>
-  <div class="sectiontitle">Classes and Modules</div>
-  Class <a href="NativeSupport/FileSystemWatcher.html" class="link">PhusionPassenger::NativeSupport::FileSystemWatcher</a><br />
-  <div class="sectiontitle">Constants</div>
-  <table border='0' cellpadding='5'>
-  <tr valign='top'>
-    <td class="attr-name">UNIX_PATH_MAX</td>
-    <td>=</td>
-    <td class="attr-value">INT2NUM(sizeof(addr.sun_path))</td>
-  </tr>
-  <tr valign='top'>
-    <td>&nbsp;</td>
-    <td colspan="2" class="attr-desc">
-The maximum length of a Unix socket path, including terminating null.
-</td>
-  </tr>
-  <tr valign='top'>
-    <td class="attr-name">SSIZE_MAX</td>
-    <td>=</td>
-    <td class="attr-value">LL2NUM(SSIZE_MAX)</td>
-  </tr>
-  <tr valign='top'>
-    <td>&nbsp;</td>
-    <td colspan="2" class="attr-desc">
-The maximum size of the data that may be passed to <a
-href="NativeSupport.html#M000034">#writev</a>.
-</td>
-  </tr>
-  </table>
-<div class="sectiontitle">Public Class methods</div>
-<div class="method">
-  <div class="title">
-    <a name="M000031"></a><b> close_all_file_descriptors(exceptions)<br />
-</b>
-  </div>
-  <div class="description">
-  <p>
-Close all file descriptors, except those given in the <tt>exceptions</tt>
-array. For example, the following would close all file descriptors except
-standard input (0) and standard output (1).
-</p>
-<pre>
- close_all_file_descriptors([0, 1])
-</pre>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000031_source')" id="l_M000031_source">show source</a> ]</p>
-  <div id="M000031_source" class="dyn-source">
-<pre>
-/*
- * call-seq: close_all_file_descriptors(exceptions)
- *
- * Close all file descriptors, except those given in the +exceptions+ array.
- * For example, the following would close all file descriptors except standard
- * input (0) and standard output (1).
- *
- *  close_all_file_descriptors([0, 1])
- */
-static VALUE
-close_all_file_descriptors(VALUE self, VALUE exceptions) {
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000030"></a><b> create_unix_socket(filename, backlog)<br />
-</b>
-  </div>
-  <div class="description">
-  <p>
-Create a SOCK_STREAM server Unix socket. Unlike Ruby&#8216;s UNIXServer
-class, this function is also able to create Unix sockets on the abstract
-namespace by prepending the filename with a null byte.
-</p>
-<ul>
-<li><tt>filename</tt> (string): The filename of the Unix socket to create.
-</li>
-<li><tt>backlog</tt> (integer): The backlog to use for listening on the socket.
-</li>
-<li>Returns: The file descriptor of the created Unix socket, as an integer.
-</li>
-<li>Raises <tt>SystemCallError</tt> if something went wrong.
-</li>
-</ul>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000030_source')" id="l_M000030_source">show source</a> ]</p>
-  <div id="M000030_source" class="dyn-source">
-<pre>
-/*
- * call-seq: create_unix_socket(filename, backlog)
- *
- * Create a SOCK_STREAM server Unix socket. Unlike Ruby's UNIXServer class,
- * this function is also able to create Unix sockets on the abstract namespace
- * by prepending the filename with a null byte.
- *
- * - +filename+ (string): The filename of the Unix socket to create.
- * - +backlog+ (integer): The backlog to use for listening on the socket.
- * - Returns: The file descriptor of the created Unix socket, as an integer.
- * - Raises +SystemCallError+ if something went wrong.
- */
-static VALUE
-create_unix_socket(VALUE self, VALUE filename, VALUE backlog) {
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000032"></a><b> disable_stdio_buffering<br />
-</b>
-  </div>
-  <div class="description">
-  <p>
-Disables any kind of buffering on the C <tt>stdout</tt> and <tt>stderr</tt>
-variables, so that +fprintf()+ on <tt>stdout</tt> and <tt>stderr</tt> have
-immediate effect.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000032_source')" id="l_M000032_source">show source</a> ]</p>
-  <div id="M000032_source" class="dyn-source">
-<pre>
-/*
- * call-seq: disable_stdio_buffering
- *
- * Disables any kind of buffering on the C +stdout+ and +stderr+ variables,
- * so that +fprintf()+ on +stdout+ and +stderr+ have immediate effect.
- */
-static VALUE
-disable_stdio_buffering(VALUE self) {
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000029"></a><b> recv_fd(socket_fd)<br />
-</b>
-  </div>
-  <div class="description">
-  <p>
-Receive a file descriptor from the given Unix socket. Returns the received
-file descriptor as an integer. Raises <tt>SystemCallError</tt> if something
-went wrong.
-</p>
-<p>
-You do not have call this method directly. A convenience wrapper is
-provided by IO#recv_io.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000029_source')" id="l_M000029_source">show source</a> ]</p>
-  <div id="M000029_source" class="dyn-source">
-<pre>
-/*
- * call-seq: recv_fd(socket_fd)
- *
- * Receive a file descriptor from the given Unix socket. Returns the received
- * file descriptor as an integer. Raises +SystemCallError+ if something went
- * wrong.
- *
- * You do not have call this method directly. A convenience wrapper is
- * provided by IO#recv_io.
- */
-static VALUE
-recv_fd(VALUE self, VALUE socket_fd) {
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000028"></a><b> send_fd(socket_fd, fd_to_send)<br />
-</b>
-  </div>
-  <div class="description">
-  <p>
-Send a file descriptor over the given Unix socket. You do not have to call
-this function directly. A convenience wrapper is provided by IO#send_io.
-</p>
-<ul>
-<li><tt>socket_fd</tt> (integer): The file descriptor of the socket.
-</li>
-<li><tt>fd_to_send</tt> (integer): The file descriptor to send.
-</li>
-<li>Raises <tt>SystemCallError</tt> if something went wrong.
-</li>
-</ul>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000028_source')" id="l_M000028_source">show source</a> ]</p>
-  <div id="M000028_source" class="dyn-source">
-<pre>
-/*
- * call-seq: send_fd(socket_fd, fd_to_send)
- *
- * Send a file descriptor over the given Unix socket. You do not have to call
- * this function directly. A convenience wrapper is provided by IO#send_io.
- *
- * - +socket_fd+ (integer): The file descriptor of the socket.
- * - +fd_to_send+ (integer): The file descriptor to send.
- * - Raises +SystemCallError+ if something went wrong.
- */
-static VALUE
-send_fd(VALUE self, VALUE socket_fd, VALUE fd_to_send) {
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000033"></a><b>split_by_null_into_hash</b>(p1)
-  </div>
-  <div class="description">
-  <p>
-Split the given string into an hash. Keys and values are obtained by
-splitting the string using the null character as the delimitor.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000033_source')" id="l_M000033_source">show source</a> ]</p>
-  <div id="M000033_source" class="dyn-source">
-<pre>
-/**
- * Split the given string into an hash. Keys and values are obtained by splitting the
- * string using the null character as the delimitor.
- */
-static VALUE
-split_by_null_into_hash(VALUE self, VALUE data) {
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000037"></a><b>switch_user</b>(p1, p2, p3)
-  </div>
-  <div class="description">
-  <p>
-Ruby&#8216;s implementations of initgroups, setgid and setuid are broken
-various ways, sigh&#8230; Ruby&#8216;s setgid and setuid can&#8216;t handle
-negative UIDs and initgroups is just broken. Work around it by using our
-own implementation.
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000037_source')" id="l_M000037_source">show source</a> ]</p>
-  <div id="M000037_source" class="dyn-source">
-<pre>
-/**
- * Ruby's implementations of initgroups, setgid and setuid are broken various ways,
- * sigh...
- * Ruby's setgid and setuid can't handle negative UIDs and initgroups is just broken.
- * Work around it by using our own implementation.
- */
-static VALUE
-switch_user(VALUE self, VALUE username, VALUE uid, VALUE gid) {
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000034"></a><b>writev</b>(p1, p2)
-  </div>
-  <div class="description">
-  <p>
-Writes all of the strings in the <tt>components</tt> array into the given
-file descriptor using the +<a
-href="NativeSupport.html#M000034">writev</a>()+ system call. Unlike
-IO#write, this method does not require one to concatenate all those strings
-into a single buffer in order to send the data in a single system call.
-Thus, <a href="NativeSupport.html#M000034">#writev</a> is a great way to
-perform zero-copy I/O.
-</p>
-<p>
-Unlike the raw <a href="NativeSupport.html#M000034">writev</a>() system
-call, this method ensures that all given data is written before returning,
-by performing multiple <a href="NativeSupport.html#M000034">writev</a>()
-calls and whatever else is necessary.
-</p>
-<pre>
-  writev(@socket.fileno, [&quot;hello &quot;, &quot;world&quot;, &quot;\n&quot;])
-</pre>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000034_source')" id="l_M000034_source">show source</a> ]</p>
-  <div id="M000034_source" class="dyn-source">
-<pre>
-/**
- * Writes all of the strings in the +components+ array into the given file
- * descriptor using the +writev()+ system call. Unlike IO#write, this method
- * does not require one to concatenate all those strings into a single buffer
- * in order to send the data in a single system call. Thus, #writev is a great
- * way to perform zero-copy I/O.
- *
- * Unlike the raw writev() system call, this method ensures that all given
- * data is written before returning, by performing multiple writev() calls
- * and whatever else is necessary.
- *
- *   writev(@socket.fileno, [&quot;hello &quot;, &quot;world&quot;, &quot;\n&quot;])
- */
-static VALUE
-f_writev(VALUE self, VALUE fd, VALUE components) {
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000035"></a><b>writev2</b>(p1, p2, p3)
-  </div>
-  <div class="description">
-  <p>
-Like <a href="NativeSupport.html#M000034">#writev</a>, but accepts two
-arrays. The data is written in the given order.
-</p>
-<pre>
-  writev2(@socket.fileno, [&quot;hello &quot;, &quot;world&quot;, &quot;\n&quot;], [&quot;another &quot;, &quot;message\n&quot;])
-</pre>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000035_source')" id="l_M000035_source">show source</a> ]</p>
-  <div id="M000035_source" class="dyn-source">
-<pre>
-/**
- * Like #writev, but accepts two arrays. The data is written in the given order.
- *
- *   writev2(@socket.fileno, [&quot;hello &quot;, &quot;world&quot;, &quot;\n&quot;], [&quot;another &quot;, &quot;message\n&quot;])
- */
-static VALUE
-f_writev2(VALUE self, VALUE fd, VALUE components1, VALUE components2) {
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000036"></a><b>writev3</b>(p1, p2, p3, p4)
-  </div>
-  <div class="description">
-  <p>
-Like <a href="NativeSupport.html#M000034">#writev</a>, but accepts three
-arrays. The data is written in the given order.
-</p>
-<pre>
-  writev3(@socket.fileno,
-    [&quot;hello &quot;, &quot;world&quot;, &quot;\n&quot;],
-    [&quot;another &quot;, &quot;message\n&quot;],
-    [&quot;yet &quot;, &quot;another &quot;, &quot;one&quot;, &quot;\n&quot;])
-</pre>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000036_source')" id="l_M000036_source">show source</a> ]</p>
-  <div id="M000036_source" class="dyn-source">
-<pre>
-/**
- * Like #writev, but accepts three arrays. The data is written in the given order.
- *
- *   writev3(@socket.fileno,
- *     [&quot;hello &quot;, &quot;world&quot;, &quot;\n&quot;],
- *     [&quot;another &quot;, &quot;message\n&quot;],
- *     [&quot;yet &quot;, &quot;another &quot;, &quot;one&quot;, &quot;\n&quot;])
- */
-static VALUE
-f_writev3(VALUE self, VALUE fd, VALUE components1, VALUE components2, VALUE components3) {
-</pre>
-  </div>
-</div>
-</div>
-</div>
-  </div>
-    </body>
-</html>