| HTTP::Daemon(3pm) | User Contributed Perl Documentation | HTTP::Daemon(3pm) |
HTTP::Daemon - a simple http server class
use HTTP::Daemon;
use HTTP::Status;
my $d = HTTP::Daemon->new || die;
print "Please contact me at: <URL:", $d->url, ">\n";
while (my $c = $d->accept) {
while (my $r = $c->get_request) {
if ($r->method eq 'GET' and $r->uri->path eq "/xyzzy") {
# remember, this is *not* recommended practice :-)
$c->send_file_response("/etc/passwd");
}
else {
$c->send_error(RC_FORBIDDEN)
}
}
$c->close;
undef($c);
}
Instances of the "HTTP::Daemon" class are HTTP/1.1 servers that listen on a socket for incoming requests. The "HTTP::Daemon" is a subclass of "IO::Socket::IP", so you can perform socket operations directly on it too.
The accept() method will return when a connection from a client is available. The returned value will be an "HTTP::Daemon::ClientConn" object which is another "IO::Socket::IP" subclass. Calling the get_request() method on this object will read data from the client and return an "HTTP::Request" object. The ClientConn object also provide methods to send back various responses.
This HTTP daemon does not fork(2) for you. Your application, i.e. the user of the "HTTP::Daemon" is responsible for forking if that is desirable. Also note that the user is responsible for generating responses that conform to the HTTP/1.1 protocol.
The following methods of "HTTP::Daemon" are new (or enhanced) relative to the "IO::Socket::IP" base class:
A server that wants to bind to some specific address on the standard HTTP port will be constructed like this:
$d = HTTP::Daemon->new(
LocalAddr => 'www.thisplace.com',
LocalPort => 80,
);
See IO::Socket::IP for a description of other arguments that can be used configure the daemon during construction.
The accept method will return "undef" if timeouts have been enabled and no connection is made within the given time. The timeout() method is described in IO::Socket::IP.
In list context both the client object and the peer address will be returned; see the description of the accept method IO::Socket for details.
The default is the string "libwww-perl-daemon/#.##" where "#.##" is replaced with the version number of this module.
The "HTTP::Daemon::ClientConn" is a "IO::Socket::IP" subclass. Instances of this class are returned by the accept() method of "HTTP::Daemon". The following methods are provided:
The get_request() method will normally not return until the whole request has been received from the client. This might not be what you want if the request is an upload of a large file (and with chunked transfer encoding HTTP can even support infinite request messages - uploading live audio for instance). If you pass a TRUE value as the $headers_only argument, then get_request() will return immediately after parsing the request headers and you are responsible for reading the rest of the request content. If you are going to call $c->get_request again on the same connection you better read the correct number of bytes.
If you handle the reading of the request content yourself you need to empty this buffer before you read more and you need to place unconsumed bytes here. You also need this buffer if you implement services like 101 Switching Protocols.
This method always returns the old buffer content and can optionally replace the buffer content if you pass it an argument.
This attribute is turned on automatically if the client announces protocol HTTP/1.0 or worse and does not include a "Connection: Keep-Alive" header. It is also turned on automatically when HTTP/1.1 or better clients send the "Connection: close" request header.
See the description of send_status_line() for the description of the accepted arguments.
The content attribute of the "HTTP::Response" object can be a normal string or a subroutine reference. If it is a subroutine, then whatever this callback routine returns is written back to the client as the response content. The routine will be called until it return an undefined or empty value. If the client is HTTP/1.1 aware then we will use chunked transfer encoding for the response.
RFC 2616
IO::Socket::IP, IO::Socket
Copyright 1996-2003, Gisle Aas
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| 2019-03-01 | perl v5.28.1 |