use Config;
+use ExtUtils::MakeMaker;
-open OUT, ">FCGI.xs";
+do 'FCGI.cfg' or die "no FCGI.cfg";
-print "Generating FCGI.xs for Perl version $]\n";
-#unless (exists $Config{apiversion} && $Config{apiversion} >= 5.005)
-unless ($] >= 5.005) {
- for (qw(sv_undef diehook warnhook in_eval)) {
- print OUT "#define PL_$_ $_\n"
- }
+open OUT, ">FCGI.pm";
+
+print "Generating FCGI.pm\n";
+print OUT <<'EOP';
+# $Id: FCGI.PL,v 1.37 2002/12/15 20:02:48 skimo Exp $
+
+package FCGI;
+
+require Exporter;
+require DynaLoader;
+
+@ISA = qw(Exporter DynaLoader);
+# Items to export into callers namespace by default. Note: do not export
+# names by default without a very good reason. Use EXPORT_OK instead.
+# Do not simply export all your public functions/methods/constants.
+@EXPORT = qw(
+
+);
+
+EOP
+
+print OUT '$VERSION = q{'.MM->parse_version('version.pm')."};\n\n";
+
+print OUT "bootstrap FCGI;\n" unless ($pure);
+
+print OUT '$VERSION = eval $VERSION;';
+
+print OUT <<'EOP' if ($pure);
+use Symbol;
+use POSIX 'ENOTCONN';
+
+use constant VERSION_1 => 1;
+
+use constant BEGIN_REQUEST => 1;
+use constant PARAMS => 4;
+use constant FCGI_STDIN => 5;
+use constant FCGI_STDOUT => 6;
+use constant FCGI_STDERR => 7;
+
+use constant RESPONDER => 1;
+use constant AUTHORIZER => 2;
+use constant FILTER => 3;
+
+%FCGI::rolenames = (RESPONDER, "RESPONDER",
+ AUTHORIZER, "AUTHORIZER",
+ FILTER, "FILTER",
+ );
+
+# This only works on Unix; anyone familiar with Windows is welcome
+# to give a hand here
+sub IsFastCGI {
+ my ($req) = @_;
+ $req->{isfastcgi} =
+ (!defined getpeername shift->{listen_sock}) && $! == ENOTCONN
+ unless exists $req->{isfastcgi};
+ return $req->{isfastcgi};
}
-print OUT while <DATA>;
-close OUT;
-__END__
-/* $Id: FCGI.PL,v 1.13 2000/01/31 21:34:24 skimo Exp $ */
-
-#include "EXTERN.h"
-#include "perl.h"
-#include "XSUB.h"
-
-#include "fcgi_config.h"
-#include "fcgiapp.h"
-#include "fastcgi.h"
-
-#ifndef FALSE
-#define FALSE (0)
-#endif
-
-#ifndef TRUE
-#define TRUE (1)
-#endif
-
-#ifndef dTHX
-#define dTHX
-#endif
-
-#ifdef USE_SFIO
-typedef struct
-{
- Sfdisc_t disc;
- FCGX_Stream *stream;
-} FCGI_Disc;
-
-static ssize_t
-sffcgiread(f, buf, n, disc)
-Sfio_t* f; /* stream involved */
-Void_t* buf; /* buffer to read into */
-size_t n; /* number of bytes to read */
-Sfdisc_t* disc; /* discipline */
-{
- return FCGX_GetStr(buf, n, ((FCGI_Disc *)disc)->stream);
+
+sub GetEnvironment {
+ return shift->{'env'};
}
-static ssize_t
-sffcgiwrite(f, buf, n, disc)
-Sfio_t* f; /* stream involved */
-const Void_t* buf; /* buffer to read into */
-size_t n; /* number of bytes to read */
-Sfdisc_t* disc; /* discipline */
-{
- n = FCGX_PutStr(buf, n, ((FCGI_Disc *)disc)->stream);
- FCGX_FFlush(((FCGI_Disc *)disc)->stream);
- return n;
+sub read_nv_len {
+ my ($stream) = @_;
+ my $buf;
+ return undef unless read $stream, $buf, 1, 0;
+ my ($len) = unpack("C", $buf);
+ if ($len & 0x80) {
+ $buf = pack("C", $len & 0x7F);
+ return undef unless read $stream, $buf, 3, 1;
+ $len = unpack("N", $buf);
+ }
+ $len;
}
-Sfdisc_t *
-sfdcnewfcgi(stream)
- FCGX_Stream *stream;
-{
- FCGI_Disc* disc;
-
- New(1000,disc,1,FCGI_Disc);
- if (!disc) return (Sfdisc_t *)disc;
-
- disc->disc.exceptf = (Sfexcept_f)NULL;
- disc->disc.seekf = (Sfseek_f)NULL;
- disc->disc.readf = sffcgiread;
- disc->disc.writef = sffcgiwrite;
- disc->stream = stream;
- return (Sfdisc_t *)disc;
+sub RequestX {
+ my $self = {
+ in => shift,
+ out => shift,
+ err => shift,
+ env => shift,
+ socket => shift,
+ flags => shift,
+ last => 0,
+ };
+ open $self->{listen_sock}, "<&=0";
+ bless $self, "FCGI";
}
-Sfdisc_t *
-sfdcdelfcgi(disc)
- Sfdisc_t* disc;
-{
- Safefree(disc);
+my $run_once = 0;
+
+sub Accept {
+ my ($req) = @_;
+
+ unless ($req->IsFastCGI()) {
+ return -1 if $run_once;
+
+ $run_once = 1;
+ return 0;
+ }
+ $req->Finish();
+ $req->{socket} = gensym();
+ if ($req->{last} || !accept($req->{socket}, $req->{listen_sock})) {
+ $req->{error} = "accept";
+ return -1;
+ }
+ my ($type, $id, $body) = $req->read_record();
+ if ($type != BEGIN_REQUEST) {
+ $req->{error} = "begin request";
+ return -1;
+ }
+ my ($role, $flags) = unpack("nC", $body);
+ $req->{role} = $role;
+ $req->{flags} = $flags;
+ $req->{id} = $id;
+
+ %{$req->{env}} = ();
+ $req->{env}{FCGI_ROLE} = $FCGI::rolenames{$req->{role}};
+ my $param = FCGI::Stream->new($req, PARAMS);
+ my ($nlen, $vlen);
+ while (defined($nlen = read_nv_len($param)) &&
+ defined($vlen = read_nv_len($param)))
+ {
+ my ($name, $val);
+ read $param, $name, $nlen;
+ read $param, $val, $vlen;
+ $req->{env}{$name} = $val;
+ }
+ $req->Bind;
+ $req->{accepted} = 1;
+
return 0;
}
-#endif
-
-#if defined(USE_LOCKING) && defined(USE_THREADS)
-static perl_mutex accept_mutex;
-#endif
-
-typedef struct FCGP_Request {
- int accepted;
- int bound;
- SV* svin;
- SV* svout;
- SV* sverr;
- GV* gv[3];
- HV* hvEnv;
- FCGX_Request* requestPtr;
-#ifdef USE_SFIO
- int sfcreated[3];
- IO* io[3];
-#endif
-} FCGP_Request;
-
-static void FCGI_Finish(FCGP_Request* request);
-
-static int
-FCGI_Flush(FCGP_Request* request)
-{
- dTHX;
-
- if(!request->bound) {
- return;
- }
-#ifdef USE_SFIO
- sfsync(IoOFP(GvIOp(request->gv[1])));
- sfsync(IoOFP(GvIOp(request->gv[2])));
-#else
- FCGX_FFlush((FCGX_Stream *) SvIV((SV*) SvRV(request->svout)));
- FCGX_FFlush((FCGX_Stream *) SvIV((SV*) SvRV(request->sverr)));
-#endif
+
+sub UndoBindings {
+ my ($req) = @_;
+ untie ${$req->{in}};
+ untie ${$req->{out}};
+ untie ${$req->{err}};
+ $req->{bound} = 0;
+}
+
+sub Bind {
+ my ($req) = @_;
+ tie ${$req->{in}}, 'FCGI::Stream', $req, FCGI_STDIN;
+ tie ${$req->{out}}, 'FCGI::Stream', $req, FCGI_STDOUT;
+ tie ${$req->{err}}, 'FCGI::Stream', $req, FCGI_STDERR;
+ $req->{bound} = 1;
}
-static void
-FCGI_UndoBinding(FCGP_Request* request)
-{
- dTHX;
-
-#ifdef USE_SFIO
- sfdcdelfcgi(sfdisc(IoIFP(request->io[0]), SF_POPDISC));
- sfdcdelfcgi(sfdisc(IoOFP(request->io[1]), SF_POPDISC));
- sfdcdelfcgi(sfdisc(IoOFP(request->io[2]), SF_POPDISC));
-#else
- sv_unmagic((SV *)request->gv[0], 'q');
- sv_unmagic((SV *)request->gv[1], 'q');
- sv_unmagic((SV *)request->gv[2], 'q');
-#endif
- request->bound = FALSE;
+sub Attach {
+ my ($req) = @_;
+ $req->Bind() if ($req->{accepted} && !$req->{bound});
}
-static void
-FCGI_Bind(FCGP_Request* request)
-{
- dTHX;
-
-#ifdef USE_SFIO
- sfdisc(IoIFP(request->io[0]), sfdcnewfcgi(fcgx_req->in));
- sfdisc(IoOFP(request->io[1]), sfdcnewfcgi(fcgx_req->out));
- sfdisc(IoOFP(request->io[2]), sfdcnewfcgi(fcgx_req->err));
-#else
- sv_magic((SV *)request->gv[1], request->svout, 'q', Nullch, 0);
- sv_magic((SV *)request->gv[2], request->sverr, 'q', Nullch, 0);
- sv_magic((SV *)request->gv[0], request->svin, 'q', Nullch, 0);
-#endif
- request->bound = TRUE;
+sub Detach {
+ my ($req) = @_;
+ $req->UndoBindings() if ($req->{accepted} && $req->{bound});
}
-static void
-populate_env(envp, hv)
-char **envp;
-HV *hv;
-{
- int i;
- char *p, *p1;
- SV *sv;
- dTHX;
-
- hv_clear(hv);
- for(i = 0; ; i++) {
- if((p = envp[i]) == NULL) {
- break;
- }
- p1 = strchr(p, '=');
- assert(p1 != NULL);
- sv = newSVpv(p1 + 1, 0);
- /* call magic for this value ourselves */
- hv_store(hv, p, p1 - p, sv, 0);
- SvSETMAGIC(sv);
+sub Finish {
+ my ($req) = @_;
+ return unless $req->{accepted};
+ if ($req->{bound}) {
+ $req->UndoBindings();
+ # apparently these are harmful
+ # close ${$req->{out}};
+ # close ${$req->{err}};
}
+ $req->{accepted} = 0;
}
-static int
-FCGI_Accept(FCGP_Request* request)
-{
- dTHX;
-
- static int isCGI = -1; /* -1: not checked; 0: FCGI; 1: FCGI */
-
- int req_isCGI =
- request->requestPtr->listen_sock == FCGI_LISTENSOCK_FILENO ?
- isCGI : 0;
-
- if(req_isCGI == -1) {
- /*
- * First call to FCGI_Accept. Is application running
- * as FastCGI or as CGI?
- */
- req_isCGI = isCGI = FCGX_IsCGI();
- } else if(req_isCGI) {
- /*
- * Not first call to FCGI_Accept and running as CGI means
- * application is done.
- */
- return(EOF);
- }
- if(!req_isCGI) {
- FCGX_Request *fcgx_req = request->requestPtr;
- int acceptResult;
-
- FCGI_Finish(request);
-#if defined(USE_LOCKING) && defined(USE_THREADS)
- MUTEX_LOCK(&accept_mutex);
-#endif
- acceptResult = FCGX_Accept_r(fcgx_req);
-#if defined(USE_LOCKING) && defined(USE_THREADS)
- MUTEX_UNLOCK(&accept_mutex);
-#endif
- if(acceptResult < 0) {
- return acceptResult;
- }
+sub LastCall {
+ shift->{last} = 1;
+}
- populate_env(fcgx_req->envp, request->hvEnv);
-
-#ifdef USE_SFIO
- for (i = 0; i < 3; ++i) {
- request->io[i] = GvIOn(request->gv[i]);
- if (!(i == 0 ? IoIFP(request->io[i])
- : IoOFP(request->io[i]))) {
- IoIFP(request->io[i]) = sftmp(0);
- /*IoIFP(request->io[i]) = sfnew(NULL, NULL, SF_UNBOUND, 0,
- SF_STRING | (i ? SF_WRITE : SF_READ));*/
- if (i != 0)
- IoOFP(request->io[i]) = IoIFP(request->io[i]);
- request->sfcreated[i] = TRUE;
- }
- }
-#else
- if (!request->svout) {
- newSVrv(request->svout = newSV(0), "FCGI::Stream");
- newSVrv(request->sverr = newSV(0), "FCGI::Stream");
- newSVrv(request->svin = newSV(0), "FCGI::Stream");
- }
- sv_setiv(SvRV(request->svout), (IV) fcgx_req->out);
- sv_setiv(SvRV(request->sverr), (IV) fcgx_req->err);
- sv_setiv(SvRV(request->svin), (IV) fcgx_req->in);
-#endif
- FCGI_Bind(request);
- request->accepted = TRUE;
- }
- return 0;
+sub DESTROY {
+ shift->Finish();
}
-static void
-FCGI_Finish(FCGP_Request* request)
-{
- dTHX;
+sub read_record {
+ my ($self) = @_;
+ my ($header, $body);
- if(!request->accepted) {
- return;
- }
+ read($self->{socket}, $header, 8);
+ my ($version, $type, $id, $clen, $plen) = unpack("CCnnC", $header);
+ read($self->{socket}, $body, $clen+$plen);
+ $body = undef if $clen == 0;
+ ($type, $id, $body);
+}
- if (request->bound) {
- FCGI_UndoBinding(request);
+sub read {
+ my ($self, $rtype, $len) = @_;
+ while (length $self->{buf} < $len) {
+ my ($type, $id, $buf) = $self->read_record();
+ return undef unless defined $buf;
+ if ($type != $rtype) {
+ $self->{error} = "unexpected stream type";
+ return 0;
+ }
+ $self->{buf} .= $buf;
}
-#ifdef USE_SFIO
- for (i = 0; i < 3; ++i) {
- if (request->sfcreated[i]) {
- sfclose(IoIFP(request->io[i]));
- IoIFP(request->io[i]) = IoOFP(request->io[i]) = Nullfp;
- request->sfcreated[i] = FALSE;
- }
+ my ($newbuf, $result) = (substr($self->{buf}, $len),
+ substr($self->{buf}, 0, $len));
+ $self->{buf} = $newbuf;
+ $result;
+}
+
+sub Flush {
+ my ($req) = @_;
+}
+
+sub write {
+ my ($self, $type, $content, $len) = @_;
+ return unless $len > 0;
+ $self->write_record($type, $content, $len);
+}
+
+sub write_record {
+ my ($self, $type, $content, $length) = @_;
+ my $offset = 0;
+ while ($length > 0) {
+ my $len = $length > 32*1024 ? 32*1024 : $length;
+ my $padlen = (8 - ($len % 8)) % 8;
+ my $templ = "CCnnCxa${len}x$padlen";
+ my $data = pack($templ,
+ VERSION_1, $type, $self->{id}, $len, $padlen,
+ substr($content, $offset, $len));
+ syswrite $self->{socket}, $data;
+ $length -= $len;
+ $offset += $len;
}
-#endif
- FCGX_Finish_r(request->requestPtr);
- request->accepted = FALSE;
}
-static int
-FCGI_StartFilterData(FCGP_Request* request)
-{
- return request->requestPtr->in ?
- FCGX_StartFilterData(request->requestPtr->in) : -1;
+{ package FCGI::Stream;
+
+sub new {
+ my ($class, $src, $type) = @_;
+ my $handle = do { \local *FH };
+ tie($$handle, $class, $src, $type);
+ $handle;
}
-static FCGP_Request *
-FCGI_Request(in, out, err, env, socket, flags)
- GV* in;
- GV* out;
- GV* err;
- HV* env;
- int socket;
- int flags;
-{
- FCGX_Request* fcgx_req;
- FCGP_Request* req;
-
- Newz(551, fcgx_req, 1, FCGX_Request);
- FCGX_InitRequest(fcgx_req, socket, flags);
- Newz(551, req, 1, FCGP_Request);
- req->requestPtr = fcgx_req;
- req->gv[0] = in;
- req->gv[1] = out;
- req->gv[2] = err;
- req->hvEnv = env;
-
- return req;
+sub TIEHANDLE {
+ my ($class, $src, $type) = @_;
+ bless { src => $src, type => $type }, $class;
}
-static void
-FCGI_Release_Request(FCGP_Request *req)
-{
- FCGI_Finish(req);
- Safefree(req->requestPtr);
- Safefree(req);
+sub READ {
+ my ($stream, undef, $len, $offset) = @_;
+ my ($ref) = \$_[1];
+ my $buf = $stream->{src}->read($stream->{type}, $len);
+ return undef unless defined $buf;
+ substr($$ref, $offset, 0, $buf);
+ length $buf;
}
-static void
-FCGI_Init()
-{
-#if defined(USE_LOCKING) && defined(USE_THREADS)
- dTHX;
+sub PRINT {
+ my ($stream) = shift;
+ for (@_) {
+ $stream->{src}->write($stream->{type}, $_, length($_));
+ }
+ return 1;
+}
- MUTEX_INIT(&accept_mutex);
-#endif
+sub CLOSE {
+ my ($stream) = @_;
+ $stream->{src}->write_record($stream->{type}, undef, 0);
}
-typedef FCGX_Stream * FCGI__Stream;
-typedef FCGP_Request * FCGI;
-typedef GV* GLOBREF;
-typedef HV* HASHREF;
+}
-MODULE = FCGI PACKAGE = FCGI
+EOP
+print OUT while <DATA>;
+close OUT;
+__END__
-BOOT:
- FCGI_Init();
+# Preloaded methods go here.
-SV *
-RequestX(in, out, err, env, socket, flags)
- GLOBREF in;
- GLOBREF out;
- GLOBREF err;
- HASHREF env;
- int socket;
- int flags;
+# Autoload methods go after __END__, and are processed by the autosplit program.
- PROTOTYPE: ***$$$
- CODE:
- RETVAL = sv_setref_pv(newSV(0), "FCGI",
- FCGI_Request(in, out, err, env, socket, flags));
+*FAIL_ACCEPT_ON_INTR = sub() { 1 };
- OUTPUT:
- RETVAL
+sub Request(;***$*$) {
+ my @defaults = (\*STDIN, \*STDOUT, \*STDERR, \%ENV, 0, FAIL_ACCEPT_ON_INTR());
+ $_[4] = fileno($_[4]) if defined($_[4]) && defined(fileno($_[4]));
+ splice @defaults,0,@_,@_;
+ RequestX(@defaults);
+}
-int
-OpenSocket(path, backlog)
- char* path;
- int backlog;
+package FCGI::Stream;
- PROTOTYPE: $$
- CODE:
- RETVAL = FCGX_OpenSocket(path, backlog);
- OUTPUT:
- RETVAL
+sub PRINTF {
+ shift->PRINT(sprintf(shift, @_));
+}
-void
-CloseSocket(socket)
- int socket;
+sub BINMODE {
+}
- PROTOTYPE: $
- CODE:
- close(socket);
+sub READLINE {
+ my $stream = shift;
+ my ($s, $c);
+ my $rs = $/ eq '' ? "\n\n" : $/;
+ my $l = substr $rs, -1;
+ my $len = length $rs;
+
+ $c = $stream->GETC();
+ if ($/ eq '') {
+ while ($c eq "\n") {
+ $c = $stream->GETC();
+ }
+ }
+ while (defined $c) {
+ $s .= $c;
+ last if $c eq $l and substr($s, -$len) eq $rs;
+ $c = $stream->GETC();
+ }
+ $s;
+}
-int
-Accept(request)
+sub OPEN {
+ $_[0]->CLOSE;
+ if (@_ == 2) {
+ return open($_[0], $_[1]);
+ } else {
+ my $rc;
+ eval("$rc = open($_[0], $_[1], $_[2])");
+ die $@ if $@;
+ return $rc;
+ }
+}
- FCGI request;
+# Some things (e.g. IPC::Run) use fileno to determine if a filehandle is open,
+# so we return a defined, but meaningless value. (-1 being the error return
+# value from the syscall in c, meaning it can never be a valid fd no)
+# Probably a better alternative would be to return the fcgi stream fd.
+sub FILENO { -1 }
- PROTOTYPE: $
+1;
- CODE:
- RETVAL = FCGI_Accept(request);
+=pod
- OUTPUT:
- RETVAL
+=head1 NAME
+FCGI - Fast CGI module
-void
-Finish(request)
+=head1 SYNOPSIS
- FCGI request;
+ use FCGI;
- PROTOTYPE: $
+ my $count = 0;
+ my $request = FCGI::Request();
- CODE:
- {
- /*
- * Finish the request.
- */
- FCGI_Finish(request);
+ while($request->Accept() >= 0) {
+ print("Content-type: text/html\r\n\r\n", ++$count);
}
+=head1 DESCRIPTION
+
+Functions:
+
+=over 4
+
+=item FCGI::Request
+
+Creates a request handle. It has the following optional parameters:
+
+=over 8
+
+=item input perl file handle (default: \*STDIN)
+
+=item output perl file handle (default: \*STDOUT)
+
+=item error perl file handle (default: \*STDERR)
-void
-Flush(request)
+These filehandles will be setup to act as input/output/error
+on successful Accept.
- FCGI request;
+=item environment hash reference (default: \%ENV)
- PROTOTYPE: $
+The hash will be populated with the environment.
- CODE:
- FCGI_Flush(request);
+=item socket (default: 0)
-void
-Detach(request)
+Socket to communicate with the server.
+Can be the result of the OpenSocket function.
+For the moment, it's the file descriptor of the socket
+that should be passed. This may change in the future.
- FCGI request;
+You should only use your own socket if your program
+is not started by a process manager such as mod_fastcgi
+(except for the FastCgiExternalServer case) or cgi-fcgi.
+If you use the option, you have to let your FastCGI
+server know which port (and possibly server) your program
+is listening on.
+See remote.pl for an example.
- PROTOTYPE: $
+=item flags (default: 0)
- CODE:
- if (request->accepted && request->bound)
- FCGI_UndoBinding(request);
+Possible values:
-void
-Attach(request)
+=over 12
- FCGI request;
+=item FCGI::FAIL_ACCEPT_ON_INTR
- PROTOTYPE: $
+If set, Accept will fail if interrupted.
+It not set, it will just keep on waiting.
- CODE:
- if (request->accepted && !request->bound)
- FCGI_Bind(request);
+=back
+=back
-int
-StartFilterData(request)
+Example usage:
+ my $req = FCGI::Request;
- FCGI request;
+or:
+ my %env;
+ my $in = new IO::Handle;
+ my $out = new IO::Handle;
+ my $err = new IO::Handle;
+ my $req = FCGI::Request($in, $out, $err, \%env);
- PROTOTYPE: $
+=item FCGI::OpenSocket(path, backlog)
- CODE:
- RETVAL = FCGI_StartFilterData(request);
+Creates a socket suitable to use as an argument to Request.
- OUTPUT:
- RETVAL
+=over 8
-void
-DESTROY(request)
- FCGI request;
+=item path
- CODE:
- FCGI_Release_Request(request);
+Pathname of socket or colon followed by local tcp port.
+Note that some systems take file permissions into account
+on Unix domain sockets, so you'll have to make sure that
+the server can write to the created file, by changing
+the umask before the call and/or changing permissions and/or
+group of the file afterwards.
+=item backlog
+Maximum length of the queue of pending connections.
+If a connection
+request arrives with the queue full the client may receive
+an error with an indication of ECONNREFUSED.
-MODULE = FCGI PACKAGE = FCGI::Stream
+=back
-#ifndef USE_SFIO
+=item FCGI::CloseSocket(socket)
-void
-PRINT(stream, ...)
- FCGI::Stream stream;
+Close a socket opened with OpenSocket.
- PREINIT:
- int n;
+=item $req->Accept()
- CODE:
- for (n = 1; n < items; ++n) {
- STRLEN len;
- register char *tmps = (char *)SvPV(ST(n),len);
- FCGX_PutStr(tmps, len, stream);
- }
- if (SvTRUEx(perl_get_sv("|", FALSE)))
- FCGX_FFlush(stream);
+Accepts a connection on $req, attaching the filehandles and
+populating the environment hash.
+Returns 0 on success.
+If a connection has been accepted before, the old
+one will be finished first.
-int
-WRITE(stream, bufsv, len, ...)
- FCGI::Stream stream;
- SV * bufsv;
- int len;
+Note that unlike with the old interface, no die and warn
+handlers are installed by default. This means that if
+you are not running an sfio enabled perl, any warn or
+die message will not end up in the server's log by default.
+It is advised you set up die and warn handlers yourself.
+FCGI.pm contains an example of die and warn handlers.
- PREINIT:
- int offset;
- char * buf;
- STRLEN blen;
- int n;
+=item $req->Finish()
- CODE:
- offset = (items == 4) ? (int)SvIV(ST(3)) : 0;
- buf = SvPV(bufsv, blen);
- if (offset < 0) offset += blen;
- if (len > blen - offset)
- len = blen - offset;
- if (offset < 0 || offset >= blen ||
- (n = FCGX_PutStr(buf+offset, len, stream)) < 0)
- ST(0) = &PL_sv_undef;
- else {
- ST(0) = sv_newmortal();
- sv_setpvf(ST(0), "%c", n);
- }
+Finishes accepted connection.
+Also detaches filehandles.
-int
-READ(stream, bufsv, len, ...)
- FCGI::Stream stream;
- SV * bufsv;
- int len;
+=item $req->Flush()
- PREINIT:
- int offset;
- char * buf;
+Flushes accepted connection.
- CODE:
- offset = (items == 4) ? (int)SvIV(ST(3)) : 0;
- if (! SvOK(bufsv))
- sv_setpvn(bufsv, "", 0);
- buf = SvGROW(bufsv, len+offset+1);
- len = FCGX_GetStr(buf+offset, len, stream);
- SvCUR_set(bufsv, len+offset);
- *SvEND(bufsv) = '\0';
- (void)SvPOK_only(bufsv);
- SvSETMAGIC(bufsv);
- RETVAL = len;
+=item $req->Detach()
- OUTPUT:
- RETVAL
+Temporarily detaches filehandles on an accepted connection.
-SV *
-GETC(stream)
- FCGI::Stream stream;
-
- PREINIT:
- int retval;
-
- CODE:
- if ((retval = FCGX_GetChar(stream)) != -1) {
- ST(0) = sv_newmortal();
- sv_setpvf(ST(0), "%c", retval);
- } else ST(0) = &PL_sv_undef;
-
-bool
-CLOSE(stream)
- FCGI::Stream stream;
-
-# ALIAS:
-# DESTROY = 1
-
- CODE:
- RETVAL = FCGX_FClose(stream) != -1;
-
- OUTPUT:
- RETVAL
-
-#endif
+=item $req->Attach()
+
+Re-attaches filehandles on an accepted connection.
+
+=item $req->LastCall()
+
+Tells the library not to accept any more requests on this handle.
+It should be safe to call this method from signal handlers.
+
+Note that this method is still experimental and everything
+about it, including its name, is subject to change.
+
+=item $env = $req->GetEnvironment()
+
+Returns the environment parameter passed to FCGI::Request.
+
+=item ($in, $out, $err) = $req->GetHandles()
+
+Returns the file handle parameters passed to FCGI::Request.
+
+=item $isfcgi = $req->IsFastCGI()
+
+Returns whether or not the program was run as a FastCGI.
+
+=back
+
+=HEAD1 LIMITATIONS
+
+FCGI.pm isn't Unicode aware, only characters within the range 0x00-0xFF are
+supported. Attempts to output strings containing characters above 0xFF results
+in a exception: (F) C<Wide character in %s>.
+
+Users who wants the previous (FCGI.pm <= 0.68) incorrect behavior can disable the
+exception by using the C<bytes> pragma.
+
+ {
+ use bytes;
+ print "\x{263A}";
+ }
+
+
+=head1 AUTHOR
+
+Sven Verdoolaege <skimo@kotnet.org>
+
+=cut
+
+__END__
projects / catagits/fcgi2.git / blobdiff