.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" 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 "Protocol::HTTP2::Client 3pm"
.TH Protocol::HTTP2::Client 3pm "2018-08-06" "perl v5.26.2" "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"
Protocol::HTTP2::Client \- HTTP/2 client
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Protocol::HTTP2::Client;
\&
\&    # Create client object
\&    my $client = Protocol::HTTP2::Client\->new;
\&
\&    # Prepare first request
\&    $client\->request(
\&
\&        # HTTP/2 headers
\&        \*(Aq:scheme\*(Aq    => \*(Aqhttp\*(Aq,
\&        \*(Aq:authority\*(Aq => \*(Aqlocalhost:8000\*(Aq,
\&        \*(Aq:path\*(Aq      => \*(Aq/\*(Aq,
\&        \*(Aq:method\*(Aq    => \*(AqGET\*(Aq,
\&
\&        # HTTP/1.1 headers
\&        headers      => [
\&            \*(Aqaccept\*(Aq     => \*(Aq*/*\*(Aq,
\&            \*(Aquser\-agent\*(Aq => \*(Aqperl\-Protocol\-HTTP2/0.13\*(Aq,
\&        ],
\&
\&        # Callback when receive server\*(Aqs response
\&        on_done => sub {
\&            my ( $headers, $data ) = @_;
\&            ...
\&        },
\&    );
\&
\&    # Protocol::HTTP2 is just HTTP/2 protocol decoder/encoder
\&    # so you must create connection yourself
\&
\&    use AnyEvent;
\&    use AnyEvent::Socket;
\&    use AnyEvent::Handle;
\&    my $w = AnyEvent\->condvar;
\&
\&    # Plain\-text HTTP/2 connection
\&    tcp_connect \*(Aqlocalhost\*(Aq, 8000, sub {
\&        my ($fh) = @_ or die "connection failed: $!\en";
\&        
\&        my $handle;
\&        $handle = AnyEvent::Handle\->new(
\&            fh       => $fh,
\&            autocork => 1,
\&            on_error => sub {
\&                $_[0]\->destroy;
\&                print "connection error\en";
\&                $w\->send;
\&            },
\&            on_eof => sub {
\&                $handle\->destroy;
\&                $w\->send;
\&            }
\&        );
\&
\&        # First write preface to peer
\&        while ( my $frame = $client\->next_frame ) {
\&            $handle\->push_write($frame);
\&        }
\&
\&        # Receive servers frames
\&        # Reply to server
\&        $handle\->on_read(
\&            sub {
\&                my $handle = shift;
\&
\&                $client\->feed( $handle\->{rbuf} );
\&
\&                $handle\->{rbuf} = undef;
\&                while ( my $frame = $client\->next_frame ) {
\&                    $handle\->push_write($frame);
\&                }
\&
\&                # Terminate connection if all done
\&                $handle\->push_shutdown if $client\->shutdown;
\&            }
\&        );
\&    };
\&
\&    $w\->recv;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Protocol::HTTP2::Client is \s-1HTTP/2\s0 client library. It's intended to make
http2\-client implementations on top of your favorite event-loop.
.SS "\s-1METHODS\s0"
.IX Subsection "METHODS"
\fInew\fR
.IX Subsection "new"
.PP
Initialize new client object
.PP
.Vb 1
\&    my $client = Procotol::HTTP2::Client\->new( %options );
.Ve
.PP
Available options:
.IP "on_push => sub {...}" 4
.IX Item "on_push => sub {...}"
If server send push promise this callback will be invoked
.Sp
.Vb 4
\&    on_push => sub {
\&        # received PUSH PROMISE headers
\&        my $pp_header = shift;
\&        ...
\&    
\&        # if we want reject this push
\&        # return undef
\&    
\&        # if we want to accept pushed resource
\&        # return callback to receive data
\&        return sub {
\&            my ( $headers, $data ) = @_;
\&            ...
\&        }
\&    },
.Ve
.IP "upgrade => 0|1" 4
.IX Item "upgrade => 0|1"
Use \s-1HTTP/1.1\s0 Upgrade to upgrade protocol from \s-1HTTP/1.1\s0 to \s-1HTTP/2.\s0 Upgrade
possible only on plain (non-tls) connection. Default value is 0.
.Sp
See
Starting \s-1HTTP/2\s0 for \*(L"http\*(R" URIs <https://tools.ietf.org/html/rfc7540#section-3.2>
.IP "keepalive => 0|1" 4
.IX Item "keepalive => 0|1"
Keep connection alive after requests. Default value is 0. Don't forget to
explicitly call close method if set this to true.
.IP "on_error => sub {...}" 4
.IX Item "on_error => sub {...}"
Callback invoked on protocol errors
.Sp
.Vb 4
\&    on_error => sub {
\&        my $error = shift;
\&        ...
\&    },
.Ve
.IP "on_change_state => sub {...}" 4
.IX Item "on_change_state => sub {...}"
Callback invoked every time when http/2 streams change their state.
See
Stream States <https://tools.ietf.org/html/rfc7540#section-5.1>
.Sp
.Vb 4
\&    on_change_state => sub {
\&        my ( $stream_id, $previous_state, $current_state ) = @_;
\&        ...
\&    },
.Ve
.PP
\fIrequest\fR
.IX Subsection "request"
.PP
Prepare \s-1HTTP/2\s0 request.
.PP
.Vb 1
\&    $client\->request(
\&
\&        # HTTP/2 headers
\&        \*(Aq:scheme\*(Aq    => \*(Aqhttp\*(Aq,
\&        \*(Aq:authority\*(Aq => \*(Aqlocalhost:8000\*(Aq,
\&        \*(Aq:path\*(Aq      => \*(Aq/items\*(Aq,
\&        \*(Aq:method\*(Aq    => \*(AqPOST\*(Aq,
\&
\&        # HTTP/1.1 headers
\&        headers      => [
\&            \*(Aqcontent\-type\*(Aq => \*(Aqapplication/x\-www\-form\-urlencoded\*(Aq,
\&            \*(Aquser\-agent\*(Aq => \*(Aqperl\-Protocol\-HTTP2/0.06\*(Aq,
\&        ],
\&
\&        # Callback when receive server\*(Aqs response
\&        on_done => sub {
\&            my ( $headers, $data ) = @_;
\&            ...
\&        },
\&
\&        # Callback when receive stream reset
\&        on_error => sub {
\&            my $error_code = shift;
\&        },
\&
\&        # Body of POST request
\&        data => "hello=world&test=done",
\&    );
.Ve
.PP
You can chaining request one by one:
.PP
.Vb 1
\&    $client\->request( 1\-st request )\->request( 2\-nd request );
.Ve
.PP
Available callbacks:
.IP "on_done => sub {...}" 4
.IX Item "on_done => sub {...}"
Invoked when full servers response is available
.Sp
.Vb 4
\&    on_done => sub {
\&        my ( $headers, $data ) = @_;
\&        ...
\&    },
.Ve
.IP "on_headers => sub {...}" 4
.IX Item "on_headers => sub {...}"
Invoked as soon as headers have been successfully received from the server
.Sp
.Vb 3
\&    on_headers => sub {
\&        my $headers = shift;
\&        ...
\&
\&        # if we want reject any data
\&        # return undef
\&
\&        # continue
\&        return 1
\&    }
.Ve
.IP "on_data => sub {...}" 4
.IX Item "on_data => sub {...}"
If specified all data will be passed to this callback instead if on_done.
on_done will receive empty string.
.Sp
.Vb 3
\&    on_data => sub {
\&        my ( $partial_data, $headers ) = @_;
\&        ...
\&
\&        # if we want cancel download
\&        # return undef
\&
\&        # continue downloading
\&        return 1
\&    }
.Ve
.IP "on_error => sub {...}" 4
.IX Item "on_error => sub {...}"
Callback invoked on stream errors
.Sp
.Vb 4
\&    on_error => sub {
\&        my $error = shift;
\&        ...
\&    }
.Ve
.PP
\fIkeepalive\fR
.IX Subsection "keepalive"
.PP
Keep connection alive after requests
.PP
.Vb 2
\&    my $bool = $client\->keepalive;
\&    $client = $client\->keepalive($bool);
.Ve
.PP
\fIshutdown\fR
.IX Subsection "shutdown"
.PP
Get connection status:
.IP "0 \- active" 4
.IX Item "0 - active"
.PD 0
.IP "1 \- closed (you can terminate connection)" 4
.IX Item "1 - closed (you can terminate connection)"
.PD
.PP
\fIclose\fR
.IX Subsection "close"
.PP
Explicitly close connection (send \s-1GOAWAY\s0 frame). This is required if client
has keepalive option enabled.
.PP
\fInext_frame\fR
.IX Subsection "next_frame"
.PP
get next frame to send over connection to server.
Returns:
.IP "undef \- on error" 4
.IX Item "undef - on error"
.PD 0
.IP "0 \- nothing to send" 4
.IX Item "0 - nothing to send"
.IP "binary string \- encoded frame" 4
.IX Item "binary string - encoded frame"
.PD
.PP
.Vb 4
\&    # Example
\&    while ( my $frame = $client\->next_frame ) {
\&        syswrite $fh, $frame;
\&    }
.Ve
.PP
\fIfeed\fR
.IX Subsection "feed"
.PP
Feed decoder with chunks of server's response
.PP
.Vb 2
\&    sysread $fh, $binary_data, 4096;
\&    $client\->feed($binary_data);
.Ve
.PP
\fIping\fR
.IX Subsection "ping"
.PP
Send ping frame to server (to keep connection alive)
.PP
.Vb 1
\&    $client\->ping
.Ve
.PP
or
.PP
.Vb 1
\&    $client\->ping($payload);
.Ve
.PP
Payload can be arbitrary binary string and must contain 8 octets. If payload argument
is omitted client will send random data.