.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Net::HTTPS::NB 3pm"
.TH Net::HTTPS::NB 3pm "2016-10-09" "perl v5.24.1" "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"
Net::HTTPS::NB \- Non\-blocking HTTPS client
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.IP "Example of sending request and receiving response" 4
.IX Item "Example of sending request and receiving response"
.Vb 4
\&        use strict;
\&        use Net::HTTPS::NB;
\&        use IO::Select;
\&        use Errno qw/EAGAIN EWOULDBLOCK/;
\&        
\&        my $s = Net::HTTPS::NB\->new(Host => "pause.perl.org") || die $@;
\&        $s\->write_request(GET => "/");
\&        
\&        my $sel = IO::Select\->new($s);
\&        
\&        READ_HEADER: {
\&                die "Header timeout" unless $sel\->can_read(10);
\&                my($code, $mess, %h) = $s\->read_response_headers;
\&                redo READ_HEADER unless $code;
\&        }
\&        
\&        # Net::HTTPS::NB uses internal buffer for reading
\&        # so we should check it before socket check by calling read_entity_body()
\&        # it is error to wait data on socket before read_entity_body() will return undef
\&        # with $! set to EAGAIN or EWOULDBLOCK
\&        # make socket non\-blocking, so read_entity_body() will not block
\&        $s\->blocking(0);
\&        
\&        while (1) {
\&                my $buf;
\&                my $n;
\&                # try to read until error or all data received
\&                while (1) {
\&                        my $tmp_buf;
\&                        $n = $s\->read_entity_body($tmp_buf, 1024);
\&                        if ($n == \-1 || (!defined($n) && ($! == EWOULDBLOCK || $! == EAGAIN))) {
\&                                last; # no data available this time
\&                        }
\&                        elsif ($n) {
\&                                $buf .= $tmp_buf; # data received
\&                        }
\&                        elsif (defined $n) {
\&                                last; # $n == 0, all readed
\&                        }
\&                        else {
\&                                die "Read error occured: ", $!; # $n == undef
\&                        }
\&                }
\&        
\&                print $buf if length $buf;
\&                last if defined $n && $n == 0; # all readed
\&                die "Body timeout" unless $sel\->can_read(10); # wait for new data
\&        }
.Ve
.IP "Example of non-blocking connect" 4
.IX Item "Example of non-blocking connect"
.Vb 3
\&        use strict;
\&        use Net::HTTPS::NB;
\&        use IO::Select;
\&
\&        my $sock = Net::HTTPS::NB\->new(Host => \*(Aqencrypted.google.com\*(Aq, Blocking => 0);
\&        my $sele = IO::Select\->new($sock);
\&
\&        until ($sock\->connected) {
\&                if ($HTTPS_ERROR == HTTPS_WANT_READ) {
\&                        $sele\->can_read();
\&                }
\&                elsif($HTTPS_ERROR == HTTPS_WANT_WRITE) {
\&                        $sele\->can_write();
\&                }
\&                else {
\&                        die \*(AqUnknown error: \*(Aq, $HTTPS_ERROR;
\&                }
\&        }
.Ve
.PP
See `examples' subdirectory for more examples.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Same interface as Net::HTTPS but it will never try multiple reads when the
\&\fIread_response_headers()\fR or \fIread_entity_body()\fR methods are invoked. In addition
allows non-blocking connect.
.IP "If \fIread_response_headers()\fR did not see enough data to complete the headers an empty list is returned." 4
.IX Item "If read_response_headers() did not see enough data to complete the headers an empty list is returned."
.PD 0
.IP "If \fIread_entity_body()\fR did not see new entity data in its read the value \-1 is returned." 4
.IX Item "If read_entity_body() did not see new entity data in its read the value -1 is returned."
.PD
.SH "PACKAGE CONSTANTS"
.IX Header "PACKAGE CONSTANTS"
Imported by default
.PP
.Vb 2
\&        HTTPS_WANT_READ
\&        HTTPS_WANT_WRITE
.Ve
.SH "PACKAGE VARIABLES"
.IX Header "PACKAGE VARIABLES"
Imported by default
.PP
.Vb 1
\&        $HTTPS_ERROR
.Ve
.SH "METHODS"
.IX Header "METHODS"
.SS "new(%cfg)"
.IX Subsection "new(%cfg)"
Same as Net::HTTPS::new, but in addition allows `Blocking' parameter. By setting
this parameter to 0 you can perform non-blocking connect. See \fIconnected()\fR to
determine when connection completed.
.SS "\fIconnected()\fP"
.IX Subsection "connected()"
Returns true value when connection completed (https handshake done). Otherwise
returns false. In this case you can check \f(CW$HTTPS_ERROR\fR to determine what handshake
need for, read or write. \f(CW$HTTPS_ERROR\fR could be \s-1HTTPS_WANT_READ\s0 or \s-1HTTPS_WANT_WRITE\s0
respectively. See \*(L"\s-1SYNOPSIS\*(R"\s0.
.SS "blocking($flag)"
.IX Subsection "blocking($flag)"
As opposed to Net::HTTPS where blocking method consciously broken you
can set socket blocking. For example you can return socket to blocking state
after non-blocking connect.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::HTTP, Net::HTTP::NB, Net::HTTPS
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2011\-2015 Oleg G <oleg@cpan.org>.
.PP
This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.