SCGI::Request(3pm)

🌸 NAME 🌸

SCGI::Request — the part of the SCGI protocol that reads the environment 💅

Like, SCGI::Request(3pm). That's the whole thing. That's the module. She reads the environment and she does it flawlessly. 👑

---

✨ SYNOPISIS ✨

(yes bestie, that's genuinely how it's spelled in the source — we don't gatekeep, we just notice 👀)

# $request got from SCGI
$request->read_env;

read $request->connection, my $body, $request->env->{CONTENT_LENGTH};

---

💖 DESCRIPTION 💖

okay so this module implements the part of the SCGI protocol that reads the environment. That's her whole lane and she's not leaving it.

After this? All that remains is the content of the request. literally nothing else is left to do, you're basically done.

And here's the comfort: the protocol and this module guarantee that there will be a CONTENT_LENGTH for the body of the request sitting in the environment. so like, the body length is always gonna be there for you. no cap. 🫶

💅 public methods 💅

• read_env — reads the environment, blocking or non-blocking, whichever the parameter you handed to SCGI->new said. returns true if it has finished. ⭐
• env — gets the environment for this request after it's been read. heads up: this will return undef until read_env or sysread_env has been called and returned true. so don't come for her early, she's not ready 😭
• connection — returns the open connection to the client. iconic, affectionate.
• close — closes the connection. bye bestie 👋
• blocking — returns true if the connection is blocking.
• set_blocking — if the boolean argument is true it turns blocking on, otherwise it turns it off. binary queen 🎀

🔒 private methods 🔒

• _new — creates a new SCGI::Request. this is used by SCGI in the accept method, so if you're even considering using this, use that instead. i'm just the messenger 💀
• _decode_env — takes the encoded environment as a string and sets the env ready for access with env.
• _set_env — sets the environment for this request.
• _blocking_read_env — reads and decodes the environment in one go. returns true on success, raises an exception on failure. dramatic but correct. 🌈

---

👑 AUTHOR 👑

Thomas Yandell <mailto:tom+scgi@vipercode.com>

🎀 COPYRIGHT 🎀

Copyright 2005, 2006 Viper Code Limited. All rights reserved.

💜 LICENSE 💜

This file is part of SCGI (perl SCGI library).

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

okay that's the whole page bestie, go forth and read some environments 🦋 this was perl v5.36.0, dated 2022-10-13 — she's an older icon but she ate and left no crumbs, periodt ✨💖