CINXE.COM
CGI::Fast - CGI Interface for Fast CGI - metacpan.org
<!DOCTYPE html> <html lang="en-US"> <head> <title>CGI::Fast - CGI Interface for Fast CGI - metacpan.org</title> <link rel="preload" as="fetch" href="/account/login_status" crossorigin="anonymous" /> <link href="/assets/style-XFEQ536G.css" rel="stylesheet" type="text/css"> <script src="/assets/main-WXBSEDQJ.js" type="module"></script> <link rel="alternate" type="application/rss+xml" title="Recent CPAN Uploads of CGI-Fast - MetaCPAN" href="/dist/CGI-Fast/releases.rss" /> <link rel="canonical" href="https://metacpan.org/pod/CGI::Fast" /> <meta name="description" content="CGI Interface for Fast CGI" /> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5"> <link rel="shortcut icon" href="/static/icons/favicon.ico"> <link rel="apple-touch-icon" sizes="152x152" href="/static/icons/apple-touch-icon.png"> <link rel="search" href="/static/opensearch.xml" type="application/opensearchdescription+xml" title="MetaCPAN"> <script async src="https://perl-ads.perlhacks.com/perl-ads.js"></script> <script async src="https://www.googletagmanager.com/gtag/js?id=G-E82Q2V8LVD"></script> <meta property="og:site_name" content="MetaCPAN" /> <meta name="twitter:site" content="@metacpan" /> <meta property="og:type" content="article" /> <meta name="twitter:card" content="summary" /> <meta property="og:url" content="https://metacpan.org/pod/CGI::Fast" /> <meta property="og:title" content="CGI::Fast" /> <meta property="og:description" content="CGI Interface for Fast CGI" /> <meta property="og:image" content="https://metacpan.org/static/images/dots.png" /> </head> <body> <nav class="navbar navbar-default" role="navigation"> <div class="header-logo-large hidden-xs"> <a href="/" tabindex="0"> <svg class="logo" aria-label="MetaCPAN"> <use class="logo" href="/static/images/metacpan-logo.svg#logo" /> </svg> </a> </div> <div class="header-logo-icon visible-xs"> <a href="/"> <svg class="logo" aria-label="MetaCPAN"> <use class="logo" href="/static/images/metacpan-logo.svg#dots" /> </svg> </a> </div> <ul class="nav navbar-nav menu-items hidden-xs hidden-sm"> <li><a href="/about">About</a></li> <li><a href="/about/sponsors">Sponsor</a></li> <li><a href="https://grep.metacpan.org/">grep::cpan</a></li> <li><a href="/recent">Recent</a></li> <li><a href="/about/faq">FAQ</a></li> <li><a href="/tools">Tools</a></li> <li><a href="https://fastapi.metacpan.org/">API</a></li> </ul> <ul class="nav navbar-nav navbar-right"> <button type="button" class="searchbar-btn visible-xs visible-sm"> <i class="fa fa-search button-fa-icon"></i> </button> <form action="/search" class="searchbar-form visible-md visible-lg search-form form-horizontal"> <input type="hidden" name="size" id="metacpan_search-size" value="20"> <div class="form-group"> <div class="search-group"> <i class="fa fa-search"></i> <input type="text" name="q" placeholder="Search the CPAN" size="41" autocorrect="off" autocapitalize="off" spellcheck="false" id="metacpan_search-input" class="form-control" value=""> </div> </div> </form> <li class="icon-slidepanel visible-xs visible-sm"> <button data-toggle="slidepanel" data-target=".slidepanel"> <span class="button-fa-icon"> <i class="fa fa-bars slidepanel-open"></i> <i class="fa fa-times slidepanel-close"></i> </span> </button> </li> <li class="dropdown login-dropdown show-logged-in"> <button type="button" class="dropdown-toggle" data-toggle="dropdown"> <i class="fa fa-user button-fa-icon logged-in-icon" aria-hidden="true"></i> <i class="fas fa-chevron-down"></i> </button> <ul class="dropdown-menu"> <li><a href="/account/identities">Identities</a></li> <li><a href="/account/profile">Profile</a></li> <li><a href="/account/favorite/list">Favorites</a></li> <li> <a href="#" type="button" class="logout-button"> Logout </a> </li> </ul> </li> <li class="dropdown login-dropdown show-logged-out"> <button type="button" class="dropdown-toggle" data-toggle="dropdown"> <i class="fa fa-user button-fa-icon avatar-placeholder" aria-hidden="true"></i> <i class="fas fa-chevron-down"></i> </button> <ul class="dropdown-menu"> <li> <a href="/login/github"> <i class="fab fa-github fa-fw"></i> GitHub </a> </li> <li> <a href="/login/twitter"> <i class="fab fa-twitter fa-fw"></i> Twitter </a> </li> <li> <a href="/login/google"> <i class="fab fa-google fa-fw"></i> Google </a> </li> </ul> </li> <li class="dropdown login-dropdown hide-logged-in hide-logged-out"> <button> <i class="fa fa-user button-fa-icon" aria-hidden="true"></i> </button> </li> </ul> </nav> <div class="page-content "> <div id="perl-ad-target" class="top-notify-banner perl-ad-target"> </div> <nav class="sidebar"> <div class="slidepanel"> <ul class="nav-list "> <li class="nav-header no-margin-top"> <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The date that this version of CGI-Fast was released."> <span class="relatize">13 Nov 2023 07:24:09 UTC</span> </div> </li> <li> Distribution: <a href="/dist/CGI-Fast">CGI-Fast</a> </li> <li> Module version: 2.17 </li> <li> <a data-keyboard-shortcut="g s" href="/dist/CGI-Fast/source/lib/CGI/Fast.pm">Source</a> (<a href="/dist/CGI-Fast/source/lib/CGI/Fast.pm?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g b" href="/dist/CGI-Fast/source/lib/CGI">Browse</a> (<a href="/dist/CGI-Fast/source/lib/CGI?raw=1">raw</a>) </li> <li> <a data-keyboard-shortcut="g c" href="/dist/CGI-Fast/changes">Changes</a> </li> <li> <a rel="noopener nofollow" class="nopopup" href="https://metacpan.org/module/CGI::Fast">Homepage</a> </li> <li> <a class="nopopup" href="/dist/CGI-Fast/contribute">How to Contribute</a> </li> <li> <a rel="noopener nofollow" data-keyboard-shortcut="g r" href="https://github.com/leejo/cgi-fast">Repository</a> </li> <li> <a rel="noopener nofollow" data-keyboard-shortcut="g i" href="https://github.com/leejo/cgi-fast/issues">Issues</a> (1) </li> <li> <a rel="noopener nofollow" href="http://matrix.cpantesters.org/?dist=CGI-Fast+2.17" title="Matrix">Testers</a> <span title="(pass / fail / na)">(<a rel="noopener nofollow" href="https://www.cpantesters.org/distro/C/CGI-Fast.html?oncpan=1&distmat=1&version=2.17&grade=2" style="color: #090">423</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/C/CGI-Fast.html?oncpan=1&distmat=1&version=2.17&grade=3" style="color: #900">0</a> / <a rel="noopener nofollow" href="https://www.cpantesters.org/distro/C/CGI-Fast.html?oncpan=1&distmat=1&version=2.17&grade=4">0</a>)</span> </li> <li> <a rel="noopener nofollow" href="http://cpants.cpanauthors.org/release/LEEJO/CGI-Fast-2.17">Kwalitee</a> </li> <li> <div class="ttip" data-toggle="tooltip" data-placement="bottom" title="The # people with an indexing permission on CGI-Fast who have released something to CPAN in the last 2 years (i.e. the # people likely able to release critical fixes in a timely manner)"> Bus factor: 1 </div> </li> <li> License: perl_5 </li> <li> Perl: v5.8.1 </li> <li class="nav-header">Activity</li> <li> <div class="activity-graph"> <img src="/dist/CGI-Fast/activity.svg?res=month" /> <div class="comment">24 month</div> </div> </li> <li class="nav-header">Tools</li> <li> <a itemprop="downloadUrl" href="https://cpan.metacpan.org/authors/id/L/LE/LEEJO/CGI-Fast-2.17.tar.gz"> Download (<span itemprop="fileSize">9.05KB</span>)</a> </li> <li> <a href="https://explorer.metacpan.org/?url=%2Fmodule%2FLEEJO%2FCGI-Fast-2.17%2Flib%2FCGI%2FFast.pm"> MetaCPAN Explorer </a> </li> <li> <a href="/dist/CGI-Fast/permissions"> Permissions </a> </li> <li> <a href="/dist/CGI-Fast/releases.rss"> Subscribe to distribution </a> </li> <li> <button class="btn btn-link" data-toggle="modal" data-target="#metacpan_install-instructions-dialog"> Install Instructions </button> </li> <li> <form action="/search"> <input type="hidden" name="q" value="dist:CGI-Fast"> <input type="search" name="q" placeholder="Search distribution" class="form-control tool-bar-form"> <input type="submit" style="display: none"> </form> </li> <li> <form action="https://grep.metacpan.org/search"> <input type="hidden" name="qd" value="CGI-Fast"> <input type="hidden" name="source" value="metacpan"> <input type="search" name="q" placeholder="grep distribution" class="form-control tool-bar-form"> <input type="submit" style="display: none"> </form> </li> <li class="version-jump"> <select class="select-navigator form-control tool-bar-form"> <option disabled selected>Jump to version</option> <option disabled value="/release/LEEJO/CGI-Fast-2.17/view/lib/CGI/Fast.pm" >2.17 (LEEJO on 2023-11-13)</option> <optgroup label="BackPAN">' <option value="/release/LEEJO/CGI-Fast-2.16/view/lib/CGI/Fast.pm" >2.16 (LEEJO on 2021-09-01)</option> <option value="/release/LEEJO/CGI-Fast-2.15/view/lib/CGI/Fast.pm" >2.15 (LEEJO on 2019-04-01)</option> <option value="/release/LEEJO/CGI-Fast-2.14/view/lib/CGI/Fast.pm" >2.14 (LEEJO on 2019-03-26)</option> <option value="/release/LEEJO/CGI-Fast-2.13/view/lib/CGI/Fast.pm" >2.13 (LEEJO on 2017-11-17)</option> <option value="/release/LEEJO/CGI-Fast-2.12/view/lib/CGI/Fast.pm" >2.12 (LEEJO on 2016-11-22)</option> <option value="/release/LEEJO/CGI-Fast-2.11/view/lib/CGI/Fast.pm" >2.11 (LEEJO on 2016-11-17)</option> <option value="/release/LEEJO/CGI-Fast-2.10/view/lib/CGI/Fast.pm" >2.10 (LEEJO on 2015-06-22)</option> <option value="/release/LEEJO/CGI-Fast-2.09/view/lib/CGI/Fast.pm" >2.09 (LEEJO on 2015-03-08)</option> <option value="/release/LEEJO/CGI-Fast-2.08/view/lib/CGI/Fast.pm" >2.08 (LEEJO on 2015-03-08)</option> <option value="/release/LEEJO/CGI-Fast-2.07/view/lib/CGI/Fast.pm" >2.07 (LEEJO on 2015-02-23)</option> <option value="/release/LEEJO/CGI-Fast-2.06/view/lib/CGI/Fast.pm" >2.06 (LEEJO on 2015-02-23)</option> <option value="/release/LEEJO/CGI-Fast-2.05/view/lib/CGI/Fast.pm" >2.05 (LEEJO on 2014-12-11)</option> <option value="/release/LEEJO/CGI-Fast-2.04/view/lib/CGI/Fast.pm" >2.04 (LEEJO on 2014-10-12)</option> <option value="/release/LEEJO/CGI-Fast-2.03/view/lib/CGI/Fast.pm" >2.03 (LEEJO on 2014-09-06)</option> <option value="/release/LEEJO/CGI-Fast-2.02/view/lib/CGI/Fast.pm" >2.02 (LEEJO on 2014-06-05)</option> <option value="/release/LEEJO/CGI-Fast-2.01/view/lib/CGI/Fast.pm" >2.01 (LEEJO on 2014-05-27)</option> <option value="/release/LEEJO/CGI-Fast-2.00/view/lib/CGI/Fast.pm" >2.00 (LEEJO on 2014-05-22)</option> <option value="/release/LEEJO/CGI-Fast-1.10_02/view/lib/CGI/Fast.pm" >1.10_02 DEV (LEEJO on 2014-05-16)</option> <option value="/release/LEEJO/CGI-Fast-1.10_01/view/lib/CGI/Fast.pm" >1.10_01 DEV (LEEJO on 2014-05-16)</option> </optgroup> </select> </li> <li class="version-diff"> <select class="select-navigator form-control tool-bar-form"> <option disabled selected>Diff with version</option> <option disabled value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.17/lib/CGI/Fast.pm" >2.17 (LEEJO on 2023-11-13)</option> <optgroup label="BackPAN">' <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.16/lib/CGI/Fast.pm" >2.16 (LEEJO on 2021-09-01)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.15/lib/CGI/Fast.pm" >2.15 (LEEJO on 2019-04-01)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.14/lib/CGI/Fast.pm" >2.14 (LEEJO on 2019-03-26)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.13/lib/CGI/Fast.pm" >2.13 (LEEJO on 2017-11-17)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.12/lib/CGI/Fast.pm" >2.12 (LEEJO on 2016-11-22)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.11/lib/CGI/Fast.pm" >2.11 (LEEJO on 2016-11-17)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.10/lib/CGI/Fast.pm" >2.10 (LEEJO on 2015-06-22)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.09/lib/CGI/Fast.pm" >2.09 (LEEJO on 2015-03-08)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.08/lib/CGI/Fast.pm" >2.08 (LEEJO on 2015-03-08)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.07/lib/CGI/Fast.pm" >2.07 (LEEJO on 2015-02-23)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.06/lib/CGI/Fast.pm" >2.06 (LEEJO on 2015-02-23)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.05/lib/CGI/Fast.pm" >2.05 (LEEJO on 2014-12-11)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.04/lib/CGI/Fast.pm" >2.04 (LEEJO on 2014-10-12)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.03/lib/CGI/Fast.pm" >2.03 (LEEJO on 2014-09-06)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.02/lib/CGI/Fast.pm" >2.02 (LEEJO on 2014-06-05)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.01/lib/CGI/Fast.pm" >2.01 (LEEJO on 2014-05-27)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-2.00/lib/CGI/Fast.pm" >2.00 (LEEJO on 2014-05-22)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-1.10_02/lib/CGI/Fast.pm" >1.10_02 DEV (LEEJO on 2014-05-16)</option> <option value="/release/LEEJO/CGI-Fast-2.17/diff/LEEJO/CGI-Fast-1.10_01/lib/CGI/Fast.pm" >1.10_01 DEV (LEEJO on 2014-05-16)</option> </optgroup> </select> </li> <li> <ul class="dependencies"> <li class="nav-header">Dependencies</li> <li><a href="/pod/CGI" title="CGI" class="ellipsis">CGI</a></li> <li><a href="/pod/Carp" title="Carp" class="ellipsis">Carp</a></li> <li><a href="/pod/FCGI" title="FCGI" class="ellipsis">FCGI</a></li> <li><a href="/pod/if" title="if" class="ellipsis">if</a></li> <li><i class="ttip" title="dynamic_config enabled">and possibly others</i></li> <li> <hr> </li> <li> <a href="/module/CGI::Fast/requires">Reverse dependencies</a> </li> <li> <a href="http://deps.cpantesters.org/?module=CGI%3A%3AFast">CPAN Testers List</a> </li> <li> <a href="https://cpandeps.grinnz.com/?dist=CGI-Fast">Dependency graph</a> </li> </ul> </li> <li class="nav-header">Permalinks</li> <li> <a href="/release/LEEJO/CGI-Fast-2.17/view/lib/CGI/Fast.pm">This version</a> </li> <li> <a href="/pod/CGI::Fast">Latest version</a> </li> <li> </li> <li> </li> </ul> </div> </nav> <div class="content-navigation"> <div class="breadcrumbs"> <span> <a data-keyboard-shortcut="g a" rel="author" href="/author/LEEJO" class="author-name">Lee Johnson</a> </span> <span> / </span> <div class="release dist-release status-latest maturity-released"> <span class="dropdown"><b class="caret"></b></span> <select class="select-navigator "> <option selected value="/release/LEEJO/CGI-Fast-2.17/view/lib/CGI/Fast.pm" >2.17 (LEEJO on 2023-11-13)</option> <optgroup label="BackPAN">' <option value="/release/LEEJO/CGI-Fast-2.16/view/lib/CGI/Fast.pm" >2.16 (LEEJO on 2021-09-01)</option> <option value="/release/LEEJO/CGI-Fast-2.15/view/lib/CGI/Fast.pm" >2.15 (LEEJO on 2019-04-01)</option> <option value="/release/LEEJO/CGI-Fast-2.14/view/lib/CGI/Fast.pm" >2.14 (LEEJO on 2019-03-26)</option> <option value="/release/LEEJO/CGI-Fast-2.13/view/lib/CGI/Fast.pm" >2.13 (LEEJO on 2017-11-17)</option> <option value="/release/LEEJO/CGI-Fast-2.12/view/lib/CGI/Fast.pm" >2.12 (LEEJO on 2016-11-22)</option> <option value="/release/LEEJO/CGI-Fast-2.11/view/lib/CGI/Fast.pm" >2.11 (LEEJO on 2016-11-17)</option> <option value="/release/LEEJO/CGI-Fast-2.10/view/lib/CGI/Fast.pm" >2.10 (LEEJO on 2015-06-22)</option> <option value="/release/LEEJO/CGI-Fast-2.09/view/lib/CGI/Fast.pm" >2.09 (LEEJO on 2015-03-08)</option> <option value="/release/LEEJO/CGI-Fast-2.08/view/lib/CGI/Fast.pm" >2.08 (LEEJO on 2015-03-08)</option> <option value="/release/LEEJO/CGI-Fast-2.07/view/lib/CGI/Fast.pm" >2.07 (LEEJO on 2015-02-23)</option> <option value="/release/LEEJO/CGI-Fast-2.06/view/lib/CGI/Fast.pm" >2.06 (LEEJO on 2015-02-23)</option> <option value="/release/LEEJO/CGI-Fast-2.05/view/lib/CGI/Fast.pm" >2.05 (LEEJO on 2014-12-11)</option> <option value="/release/LEEJO/CGI-Fast-2.04/view/lib/CGI/Fast.pm" >2.04 (LEEJO on 2014-10-12)</option> <option value="/release/LEEJO/CGI-Fast-2.03/view/lib/CGI/Fast.pm" >2.03 (LEEJO on 2014-09-06)</option> <option value="/release/LEEJO/CGI-Fast-2.02/view/lib/CGI/Fast.pm" >2.02 (LEEJO on 2014-06-05)</option> <option value="/release/LEEJO/CGI-Fast-2.01/view/lib/CGI/Fast.pm" >2.01 (LEEJO on 2014-05-27)</option> <option value="/release/LEEJO/CGI-Fast-2.00/view/lib/CGI/Fast.pm" >2.00 (LEEJO on 2014-05-22)</option> <option value="/release/LEEJO/CGI-Fast-1.10_02/view/lib/CGI/Fast.pm" >1.10_02 DEV (LEEJO on 2014-05-16)</option> <option value="/release/LEEJO/CGI-Fast-1.10_01/view/lib/CGI/Fast.pm" >1.10_01 DEV (LEEJO on 2014-05-16)</option> </optgroup> </select> <a data-keyboard-shortcut="g d" class="release-name" href="/dist/CGI-Fast">CGI-Fast-2.17</a> </div> <span class="river-gauge-gauge"> <svg width="24px" height="15px" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"> <g> <title> River stage two • 7 direct dependents • 11 total dependents </title> <rect x="0" y="0" width="4" height="15" fill="#7ea3f2" /> <rect x="5" y="0" width="4" height="15" fill="#7ea3f2" /> <rect x="10" y="0" width="4" height="15" fill="#e4e2e2" /> <rect x="15" y="0" width="4" height="15" fill="#e4e2e2" /> <rect x="20" y="0" width="4" height="15" fill="#e4e2e2" /> </g> </svg> </span> <div id="CGI-Fast-fav" class="show-logged-in"> <form action="/account/favorite/add" style="display: inline" method="POST"> <input type="hidden" name="remove" value="0"> <input type="hidden" name="release" value="CGI-Fast-2.17"> <input type="hidden" name="author" value="LEEJO"> <input type="hidden" name="distribution" value="CGI-Fast"> <button type="submit" class="favorite"><span></span> ++</button> </form> </div> <div class="show-logged-out"> <button class="fav-not-logged-in favorite"><span></span> ++</button> </div> / <span>CGI::Fast</span> </div> </div> <main class="content"> <nav class="toc"> <div class="toc-header"><strong>Contents</strong></div> <ul> <li><a href="#NAME">NAME</a></li> <li><a href="#SYNOPSIS">SYNOPSIS</a></li> <li><a href="#DESCRIPTION">DESCRIPTION</a></li> <li><a href="#OTHER-PIECES-OF-THE-PUZZLE">OTHER PIECES OF THE PUZZLE</a></li> <li><a href="#WRITING-FASTCGI-PERL-SCRIPTS">WRITING FASTCGI PERL SCRIPTS</a></li> <li><a href="#INSTALLING-FASTCGI-SCRIPTS">INSTALLING FASTCGI SCRIPTS</a></li> <li><a href="#USING-FASTCGI-SCRIPTS-AS-CGI-SCRIPTS">USING FASTCGI SCRIPTS AS CGI SCRIPTS</a></li> <li><a href="#EXTERNAL-FASTCGI-SERVER-INVOCATION">EXTERNAL FASTCGI SERVER INVOCATION</a></li> <li><a href="#FILE-HANDLES">FILE HANDLES</a></li> <li><a href="#CAVEATS">CAVEATS</a></li> <li><a href="#LICENSE">LICENSE</a></li> <li><a href="#BUGS">BUGS</a></li> <li><a href="#SEE-ALSO">SEE ALSO</a></li> </ul></nav> <div class="pod anchors"> <h1 id="NAME">NAME</h1> <p>CGI::Fast - CGI Interface for Fast CGI</p> <a href="https://travis-ci.org/leejo/cgi-fast?branch=master"><img alt="Build Status" src="https://travis-ci.org/leejo/cgi-fast.svg?branch=master" /></a> <a href="https://coveralls.io/r/leejo/cgi-fast?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/leejo/cgi-fast/badge.png?branch=master" /></a> <h1 id="SYNOPSIS">SYNOPSIS</h1> <pre><code>use CGI::Fast socket_path => '9000', socket_perm => 0777, listen_queue => 50; use CGI qw/ :standard /; $COUNTER = 0; # optional, will default to STDOUT, STDERR CGI::Fast->file_handles({ fcgi_output_file_handle => IO::Handle->new, fcgi_error_file_handle => IO::Handle->new, }); while ($q = CGI::Fast->new) { process_request($q); }</code></pre> <h1 id="DESCRIPTION">DESCRIPTION</h1> <p>CGI::Fast is a subclass of the CGI object created by CGI.pm. It is specialized to work with the FCGI module, which greatly speeds up CGI scripts by turning them into persistently running server processes. Scripts that perform time-consuming initialization processes, such as loading large modules or opening persistent database connections, will see large performance improvements.</p> <p>Note that as CGI::Fast is based on CGI.pm it is no longer advised as a way to write Perl web apps. See <a href="https://metacpan.org/pod/CGI#CGI.pm-HAS-BEEN-REMOVED-FROM-THE-PERL-CORE">https://metacpan.org/pod/CGI#CGI.pm-HAS-BEEN-REMOVED-FROM-THE-PERL-CORE</a> for more information about this</p> <h1 id="OTHER-PIECES-OF-THE-PUZZLE"><a id="OTHER"></a>OTHER PIECES OF THE PUZZLE</h1> <p>In order to use CGI::Fast you'll need the FCGI module. See http://www.cpan.org/ for details.</p> <h1 id="WRITING-FASTCGI-PERL-SCRIPTS"><a id="WRITING"></a>WRITING FASTCGI PERL SCRIPTS</h1> <p>FastCGI scripts are persistent: one or more copies of the script are started up when the server initializes, and stay around until the server exits or they die a natural death. After performing whatever one-time initialization it needs, the script enters a loop waiting for incoming connections, processing the request, and waiting some more.</p> <p>A typical FastCGI script will look like this:</p> <pre><code>#!perl use CGI::Fast; do_some_initialization(); while ($q = CGI::Fast->new) { process_request($q); }</code></pre> <p>Each time there's a new request, CGI::Fast returns a CGI object to your loop. The rest of the time your script waits in the call to new(). When the server requests that your script be terminated, new() will return undef. You can of course exit earlier if you choose. A new version of the script will be respawned to take its place (this may be necessary in order to avoid Perl memory leaks in long-running scripts).</p> <p>CGI.pm's default CGI object mode also works. Just modify the loop this way:</p> <pre><code>while (CGI::Fast->new) { process_request(); }</code></pre> <p>Calls to header(), start_form(), etc. will all operate on the current request.</p> <h1 id="INSTALLING-FASTCGI-SCRIPTS"><a id="INSTALLING"></a>INSTALLING FASTCGI SCRIPTS</h1> <p>See the FastCGI developer's kit documentation for full details. On the Apache server, the following line must be added to srm.conf:</p> <pre><code>AddType application/x-httpd-fcgi .fcgi</code></pre> <p>FastCGI scripts must end in the extension .fcgi. For each script you install, you must add something like the following to srm.conf:</p> <pre><code>FastCgiServer /usr/etc/httpd/fcgi-bin/file_upload.fcgi -processes 2</code></pre> <p>This instructs Apache to launch two copies of file_upload.fcgi at startup time.</p> <h1 id="USING-FASTCGI-SCRIPTS-AS-CGI-SCRIPTS"><a id="USING"></a>USING FASTCGI SCRIPTS AS CGI SCRIPTS</h1> <p>Any script that works correctly as a FastCGI script will also work correctly when installed as a vanilla CGI script. However it will not see any performance benefit.</p> <h1 id="EXTERNAL-FASTCGI-SERVER-INVOCATION"><a id="EXTERNAL"></a>EXTERNAL FASTCGI SERVER INVOCATION</h1> <p>FastCGI supports a TCP/IP transport mechanism which allows FastCGI scripts to run external to the webserver, perhaps on a remote machine. To configure the webserver to connect to an external FastCGI server, you would add the following to your srm.conf:</p> <pre><code>FastCgiExternalServer /usr/etc/httpd/fcgi-bin/file_upload.fcgi -host sputnik:8888</code></pre> <p>Two environment variables affect how the <code>CGI::Fast</code> object is created, allowing <code>CGI::Fast</code> to be used as an external FastCGI server. (See <code>FCGI</code> documentation for <code>FCGI::OpenSocket</code> for more information.)</p> <p>You can set these as ENV variables or imports in the use CGI::Fast statement. If the ENV variables are set then these will be favoured so you can override the import statements on the command line, etc.</p> <dl> <dt id="FCGI_SOCKET_PATH-/-socket_path"><a id="FCGI_SOCKET_PATH"></a><a id="FCGI_SOCKET_PATH-socket_path"></a>FCGI_SOCKET_PATH / socket_path</dt> <dd> <p>The address (TCP/IP) or path (UNIX Domain) of the socket the external FastCGI script to which bind an listen for incoming connections from the web server.</p> </dd> <dt id="FCGI_SOCKET_PERM-/-socket_perm"><a id="FCGI_SOCKET_PERM"></a><a id="FCGI_SOCKET_PERM-socket_perm"></a>FCGI_SOCKET_PERM / socket_perm</dt> <dd> <p>Permissions for UNIX Domain socket.</p> </dd> <dt id="FCGI_LISTEN_QUEUE-/-listen_queue"><a id="FCGI_LISTEN_QUEUE"></a><a id="FCGI_LISTEN_QUEUE-listen_queue"></a>FCGI_LISTEN_QUEUE / listen_queue</dt> <dd> <p>Maximum length of the queue of pending connections, defaults to 100.</p> </dd> </dl> <p>For example:</p> <pre><code>use CGI::Fast socket_path => "sputnik:8888", listen_queue => "50" ; use CGI qw/ :standard /; do_some_initialization(); while ($q = CGI::Fast->new) { process_request($q); }</code></pre> <p>Or:</p> <pre><code>use CGI::Fast; use CGI qw/ :standard /; do_some_initialization(); $ENV{FCGI_SOCKET_PATH} = "sputnik:8888"; $ENV{FCGI_LISTEN_QUEUE} = 50; while ($q = CGI::Fast->new) { process_request($q); }</code></pre> <p>Note the importance of having use CGI after use CGI::Fast as this will prevent any CGI import pragmas being overwritten by CGI::Fast. You can use CGI::Fast as a drop in replacement like so:</p> <pre><code>use CGI::Fast qw/ :standard /</code></pre> <h1 id="FILE-HANDLES"><a id="FILE"></a>FILE HANDLES</h1> <p>FCGI defaults to using STDOUT and STDERR as its output filehandles - this may lead to unexpected redirect of output if you migrate scripts from CGI.pm to CGI::Fast. To get around this you can use the file_handles method, which you must do <b>before</b> the first call to CGI::Fast->new. For example using IO::Handle:</p> <pre><code>CGI::Fast->file_handles({ fcgi_output_file_handle => IO::Handle->new, fcgi_error_file_handle => IO::Handle->new, }); while (CGI::Fast->new) { .. }</code></pre> <p>Overriding STDIN using the <code>fcgi_input_file_handle</code> key is also possible, however doing so is likely to break at least POST requests.</p> <h1 id="CAVEATS">CAVEATS</h1> <p>I haven't tested this very much.</p> <h1 id="LICENSE">LICENSE</h1> <p>Copyright 1996-1998, Lincoln D. Stein. All rights reserved. Currently maintained by Lee Johnson</p> <p>This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p> <h1 id="BUGS">BUGS</h1> <p>Address bug reports and comments to:</p> <pre><code>https://github.com/leejo/cgi-fast</code></pre> <h1 id="SEE-ALSO"><a id="SEE"></a>SEE ALSO</h1> <p><a href="/pod/CGI::Carp">CGI::Carp</a>, <a href="/pod/CGI">CGI</a></p></div> <div id="metacpan_install-instructions-dialog" class="modal fade"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button> <h4 class="modal-title">Module Install Instructions</h4> </div> <div class="modal-body"> <p>To install CGI::Fast, copy and paste the appropriate command in to your terminal.</p> <p><a href="/dist/App-cpanminus/view/bin/cpanm">cpanm</a></p> <pre><code>cpanm CGI::Fast</code></pre> <p><a href="/pod/CPAN">CPAN shell</a></p> <pre><code>perl -MCPAN -e shell install CGI::Fast</code></pre> <p>For more information on module installation, please visit <a href="https://www.cpan.org/modules/INSTALL.html">the detailed CPAN module installation guide</a>.</p> </div> <div class="modal-footer"> <a href="#" data-dismiss="modal" class="btn">Close</a> </div> </div> </div> </div> </main> <div class="content-pagination"> </div> </div> <footer class="footer"> <div class="footer-container"> <div class="footer-social"> <div class="footer-link footer-logo"> <a href="/"> <img src="/static/images/metacpan-logo.svg" alt="MetaCPAN" /> </a> </div> <a class="footer-social-link" href="https://github.com/metacpan"> <i class="fab fa-github-square"></i> </a> <a class="footer-social-link" href="https://fosstodon.org/@metacpan"> <i class="fab fa-mastodon"></i> </a> </div> <div class="footer-links"> <div class="footer-link"> <a href="/about">About</a> </div> <div class="footer-link"> <a href="/about/sponsors">Sponsor</a> </div> <div class="footer-link"> <a href="https://grep.metacpan.org">grep::cpan</a> </div> <div class="footer-link"> <a href="/recent">Recent</a> </div> <div class="footer-link"> <a href="/about/faq">FAQ</a> </div> <div class="footer-link"> <a href="/tools">Tools</a> </div> <div class="footer-link"> <a href="https://fastapi.metacpan.org/">API</a> </div> <div class="footer-link"> <a href="https://www.perl.org/">Perl.org</a> </div> </div> <div class="footer-sponsors"> <a class="footer-sponsor-link" target="_blank" href="https://www.bytemark.co.uk/" rel="noopener"> <img class="footer-sponsor-bytemark" src="/static/images/sponsors/bytemark_logo.svg" alt="Bytemark logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://www.liquidweb.com/" rel="noopener"> <img class="footer-sponsor-liquidweb" src="/static/images/sponsors/liquidweb_logo.png" alt="liquidweb logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://deriv.com/careers/" rel="noopener"> <img class="footer-sponsor-deriv" src="/static/images/sponsors/deriv.svg" alt="Deriv logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://geocode.xyz" rel="noopener"> <img class="footer-sponsor-geocode" src="/static/images/sponsors/geocodelogo.svg" alt="Geocode logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://www.fastly.com/" rel="noopener"> <img class="footer-sponsor-fastly" src="/static/images/sponsors/fastly_logo.svg" alt="Fastly logo"> </a> <a class="footer-sponsor-link" target="_blank" href="https://opencagedata.com" rel="noopener"> <img class="footer-sponsor-opencage" src="/static/images/sponsors/open-cage.svg" alt="OpenCage logo"> </a> <!-- Added 2024-07-22 --> <a class="footer-sponsor-link" target="_blank" href="https://www.elastic.co/" rel="noopener"> <img class="footer-sponsor-elastic" src="/static/images/sponsors/elastic.svg" alt="Elastic logo"> </a> <!-- Added 2024-07-22 --> <a class="footer-sponsor-link" target="_blank" href="https://route4me.com/" rel="noopener"> <img class="footer-sponsor-route4me" src="/static/images/sponsors/route4me.png" alt="Route4Me logo"> </a> </div> </div> </footer> <div class="modal fade" tabindex="-1" role="dialog" id="metacpan_keyboard-shortcuts"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal">×</button> <h4 class="modal-title">Keyboard Shortcuts</h4> </div> <div class="modal-body row"> <div class="col-md-6"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>Global</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>s</kbd> </td> <td>Focus search bar</td> </tr> <tr> <td class="keys"> <kbd>?</kbd> </td> <td>Bring up this help dialog</td> </tr> </tbody> </table> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>GitHub</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>g</kbd> <kbd>p</kbd> </td> <td>Go to pull requests</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>i</kbd> </td> <td>go to github issues (only if github is preferred repository)</td> </tr> </tbody> </table> </div> <div class="col-md-6"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>POD</th> </tr> </thead> <tbody> <tr> <td class="keys"> <kbd>g</kbd> <kbd>a</kbd> </td> <td>Go to author</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>c</kbd> </td> <td>Go to changes</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>i</kbd> </td> <td>Go to issues</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>d</kbd> </td> <td>Go to dist</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>r</kbd> </td> <td>Go to repository/SCM</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>s</kbd> </td> <td>Go to source</td> </tr> <tr> <td class="keys"> <kbd>g</kbd> <kbd>b</kbd> </td> <td>Go to file browse</td> </tr> </tbody> </table> </div> <div class="col-md-12"> <table class="table keyboard-shortcuts"> <thead> <tr> <th></th> <th>Search terms</th> </tr> </thead> <tbody> <tr> <td><em>module:</em> (e.g. <a href="/search?q=module%3APlugin">module:Plugin</a>)</td> </tr> <tr> <td><em>distribution:</em> (e.g. <a href="/search?q=distribution%3ADancer+auth">distribution:Dancer auth</a>)</td> </tr> <tr> <td><em>author:</em> (e.g. <a href="/search?q=author%3ASONGMU+Redis">author:SONGMU Redis</a>)</td> </tr> <tr> <td><em>version:</em> (e.g. <a href="/search?q=version%3A1.00">version:1.00</a>)</td> </tr> </tbody> </table> </div> </div> <div class="modal-footer"></div> </div> </div> </div> </body> </html>