JSON::...::Call(3pm)

✨ JSON::RPC::Common::Procedure::Call ✨

okay bestie, gather round, we're doing the JSON::...::Call(3pm) page, from the User Contributed Perl Documentation. this is the JSON::RPC::Common::Procedure::Call base class, and she is iconic 💅

---

🌸 VERSION 🌸

version 0.11 — that's the vibe, that's the era, periodt.

---

🦋 SYNOPSIS 🦋

use JSON::RPC::Common::Procedure::Call;

my $req = JSON::RPC::Common::Procedure::Call->inflate({ ... });

warn "HALLO JSONRPC VERSION " . $req->version;

literally that's it. that's the whole entrance. no cap 🫶

---

💖 DESCRIPTION 💖

so a JSON-RPC Procedure Call — and yes, the original author is over here like rolls eyes, what was even wrong with just calling it a "request"?? — is either a notification or a method invocation in JSON-RPC. two moods, one class. 🎀

peep <http://json-rpc.org/wiki/specification> → keep that URL handy as http://json-rpc.org/wiki/specification if u wanna read the spec for more deets. iykyk ✨

---

👑 ATTRIBUTES 👑

quick heads up before we go: all attributes are read only unless the docs say otherwise. no sneaky writes, bestie. 🙈

• version — she's here, she's an attribute, that's the whole note. ⭐
• id — The request ID.

used to correlate a request to a response, aka how u know which reply goes with which ask. matching energy fr fr 🧚

• method — The name of the method to invoke. say it with ur chest.
• params — returns a reference to the parameters hash or array. hash or array, she contains multitudes 💜
• return_class — one of the classes u instantiate the response objects from.
• error_class — the other one of the classes u instantiate the response objects from.

these two vary per subclass! every subclass does its own thing, no uniform here. 🌈

---

🔥 METHODS 🔥

• inflate — a factory constructor. she delegates to new on a subclass, picked based on the protocol version.

this is the recommended constructor. yes queen, use this one. 👑

• deflate — flatten to JSON data. squish it down, send it out. ✨
• new — the actual constructor.

not intended for normal use on this class — u should be using a subclass most of the time, ok?

calling JSON::RPC::Common::Procedure::Call->new will construct a call with an undefined version, which cannot be deflated (and thus can't be sent over the wire). still useful for testing ur own code's RPC handling, so this is not allowed.

🚨 wait. read that again. it says "this is still useful for testing... so this is not allowed." that's literally what the original says. so like, it's useful, and also not allowed. do with that information what u will. 💀

• params_list — dereferences params regardless of representation.

returns a list of positionals or a key/value list. either way u get a list, bestie. 🍓

• return_result $result — create a new JSON::RPC::Common::Procedure::Return with a result.
• return_error %error_params — create a new JSON::RPC::Common::Procedure::Return with an error.

(yeah these two are a duo, one for the good timeline, one for the bad one 😭)

• is_notification — whether this request is a notification, aka a method that does not need a response. she said don't text back. 💅
• is_service — whether this request is a JSON-RPC 1.1 service method (e.g. system.describe).

this method is always false for 1.0 and 2.0. so if ur on those versions, don't even ask, the answer is no. 🙈

• call $obj — a convenience method to invoke the call on $obj and create a new return with the return value. run it, catch the result, slay. 🎀

---

💜 AUTHOR 💜

Yuval Kogman <nothingmuch@woobling.org> — the icon, the legend, the one who wrote this whole thing. 🫶

---

🌈 COPYRIGHT AND LICENSE 🌈

This software is copyright (c) 2014 by Yuval Kogman and others.

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

---

okay that's the whole page, and ur lil sign-off is: this was rendered from perl v5.30.3, dated 2020-06-23, and she goes by JSON::...::Call(3pm) 💖✨ bye bestie, go inflate something responsibly 🦋