.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "JSON::RPC::Common::Procedure::Call 3pm"
.TH JSON::RPC::Common::Procedure::Call 3pm "2020-06-23" "perl v5.30.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
JSON::RPC::Common::Procedure::Call \- JSON RPC Procedure Call base class.
.SH "VERSION"
.IX Header "VERSION"
version 0.11
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&        use JSON::RPC::Common::Procedure::Call;
\&
\&        my $req = JSON::RPC::Common::Procedure::Call\->inflate({ ... });
\&
\&        warn "HALLO JSONRPC VERSION " . $req\->version;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A JSON-RPC Procedure Call (ed: *rolls eys*, what was wrong with \*(L"request\*(R"?) is
either a notification or a method invocation in JSON-PRC.
.PP
See <http://json\-rpc.org/wiki/specification> for more details.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
All attributes are read only unless otherwise specified.
.IP "version" 4
.IX Item "version"
.PD 0
.IP "id" 4
.IX Item "id"
.PD
The request \s-1ID.\s0
.Sp
Used to correlate a request to a response.
.IP "method" 4
.IX Item "method"
The name of the method to invoke.
.IP "params" 4
.IX Item "params"
Returns a reference to the parameters hash or array.
.IP "return_class" 4
.IX Item "return_class"
.PD 0
.IP "error_class" 4
.IX Item "error_class"
.PD
The classes to instantiate the response objects.
.Sp
These vary per subclass.
.SH "METHODS"
.IX Header "METHODS"
.IP "inflate" 4
.IX Item "inflate"
A factory constructor. Delegates to \f(CW\*(C`new\*(C'\fR on a subclass based on the protocol
version.
.Sp
This is the recommended constructor.
.IP "deflate" 4
.IX Item "deflate"
Flatten to \s-1JSON\s0 data
.IP "new" 4
.IX Item "new"
The actual constructor.
.Sp
Not intended for normal use on this class, you should use a subclass most of
the time.
.Sp
Calling \f(CW\*(C`JSON::RPC::Common::Procedure::Call\->new\*(C'\fR will construct a call
with an undefined version, which cannot be deflated (and thus sent over the
wire). This is still useful for testing your own code's \s-1RPC\s0 hanlding, so this
is not allowed.
.IP "params_list" 4
.IX Item "params_list"
Dereferences \f(CW\*(C`params\*(C'\fR regardless of representation.
.Sp
Returns a list of positionals or a key/value list.
.ie n .IP "return_result $result" 4
.el .IP "return_result \f(CW$result\fR" 4
.IX Item "return_result $result"
.PD 0
.ie n .IP "return_error %error_params" 4
.el .IP "return_error \f(CW%error_params\fR" 4
.IX Item "return_error %error_params"
.PD
Create a new JSON::RPC::Common::Procedure::Return with or without an error.
.IP "is_notification" 4
.IX Item "is_notification"
Whether this request is a notification (a method that does not need a response).
.IP "is_service" 4
.IX Item "is_service"
Whether this request is a JSON-RPC 1.1 service method (e.g.
\&\f(CW\*(C`system.describe\*(C'\fR).
.Sp
This method is always false for 1.0 and 2.0.
.ie n .IP "call $obj" 4
.el .IP "call \f(CW$obj\fR" 4
.IX Item "call $obj"
A convenience method to invoke the call on \f(CW$obj\fR and create a new return with
the return value.
.SH "AUTHOR"
.IX Header "AUTHOR"
Yuval Kogman <nothingmuch@woobling.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2014 by Yuval Kogman and others.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.