AnyEven...ver::Req(3)

📦
version 1.99998 · 2 versions
, in fedora 43

💖 AnyEvent::HTTP::Server::Req 💖

okay bestie, you're reading the manual page for AnyEvent::HTTP::Server::Req (that's section 3 of the User Contributed Perl Documentation, iykyk), and it is exactly what it sounds like: the request object that AnyEvent::HTTP::Server hands you every single time somebody knocks on your server's door. ✨

🌸 NAME 🌸

AnyEvent::HTTP::Server::Req — the Request object used by AnyEvent::HTTP::Server

🎀 VERSION 🎀

Version 1.97

🦋 SYNOPSIS 🦋

here's the whole vibe, fr fr:

sub dispatch {
  my $request = shift;
  if ($request->path =~ m{ ^ /ping /? $}x) {
    $request->reply( 200, 'pong', headers=> { 'Content-Type' => 'text/plain'});
  } else {
    $request->reply( 404, 'Not found', headers=> { 'Content-Type' => 'text/plain'});
  }
}

✨ DESCRIPTION ✨

This module is a part of AnyEvent::HTTP::Server, see perldoc AnyEvent::HTTP::Server for details. 💅

🌈 EXPORT 🌈

Does not export anything. not a single thing, bestie. it's giving "self-contained icon." 💀

👑 SUBROUTINES/METHODS 👑

connection — the 'Connection' header

returns the Connection header from the client request. 🫶

method — the request method

returns the HTTP Method that was used in the request, such as GET, PUT, HEAD, POST, etc.. 🌟

full_uri — URI with the host part

the requested uri with host and protocol name. the protocol part is always http://. periodt. 🔥

uri — URI with the host part stripped

the requested uri without host and protocol name. so much lighter, honestly. 🦋

headers — headers from the client request

return value is a hash reference. all header names are lowercased. lowercase girlies only. 💅

go($location) — send a redirect

redirects the client to $location with a 302 HTTP Status code. bye bestie, go over there. 👋

reply($status,$content, $headers) — send a reply to the client

this method sends both headers and response body to the client, and it should be called at the end of request processing. like the final text in the group chat.

Parameters:

  • status — HTTP Status header (200 is OK, 403 is Auth required and so on). ✨
  • content — response body as a scalar.
  • headers — response headers as a hash reference.

replyjs( [code], $data, %arguments ) — send a reply in JSON format

  • code — optional Status code, 200 is the default.
  • data — response data to encode with JSON. all strings will be encoded as UTF-8. 🌍
  • arguments — a list of key=> value arguments. the only supported argument for a moment is pretty => 1 | 0. the JSON data will be formatted for easier reading by a human, if pretty is true. 💖

send_headers($code, @argumnets_list ) — send response headers to the client

this method may be used in conjunction with the body() and finish() methods for streaming content serving. the response header 'transfer-encoding' is set to 'chunked' by this method. 🚰

  • code — HTTP Status code to send to a client.
  • arguments_list — the rest of the arguments is interpreted as a key=>value list. one should pass the headers key, for example:
$request->send_headers(200, headers => { 'Content-type' => 'text/plain'} );

subsequent data should be sent with the body method, and after all the data is sent, finish request handling with the finish() method. the methods send_headers, body and finish should always be used together. no splitting them up, they're a package deal. 🫶

body($data ) — send a chunk of data to the client

sends part (or chunk) of data to the client. 🍓

finish — finish chunked request processing

finishes the request by sending a zero-length chunk to the client. that's the little "we're done here" signal. ⭐

abort — drop the chunked connection

lets the client know if an error occurred by dropping the connection before sending complete data. 😭

KNOWN ISSUES: nginx, when used as a reverse proxy, masks the connection abort, leaving no ability for the browser to detect the error condition. so yeah, the drama is real and the browser will simply not know. 💀

🧚 RESOURCES 🧚

💜 ACKNOWLEDGEMENTS 💜

  • Thanks to Marc Lehmann for AnyEvent. 🙏
  • Thanks to Robin Redeker for AnyEvent::HTTPD. 🙏

🌸 AUTHOR 🌸

Mons Anderson, <mons@cpan.org> 👑

📜 LICENSE 📜

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License. so like, go off, legally speaking. 🎀

okay that's the whole page bestie, and one last cute sign-off: this doc came from perl v5.42.0 and is dated 2025-07-25, so go be the main character of your own HTTP server. slay, no cap, AnyEven...ver::Req(3) out. 💅✨

📦 where this page comes from