.\" 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
.\" ========================================================================
.\"
.IX Title "Search::Elasticsearch::Cxn::Hijk 3pm"
.TH Search::Elasticsearch::Cxn::Hijk 3pm "2020-06-29" "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"
Search::Elasticsearch::Cxn::Hijk \- A Cxn implementation which uses Hijk
.SH "VERSION"
.IX Header "VERSION"
version 6.81
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Provides an \s-1HTTP\s0 Cxn class based on Hijk.
The Hijk backend is pure Perl and is very fast, faster even that
Search::Elasticsearch::Cxn::NetCurl, but doesn't provide support for
https or proxies.
.PP
This class does Search::Elasticsearch::Role::Cxn, whose documentation
provides more information, and Search::Elasticsearch::Role::Is_Sync.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
.ie n .SS """connect_timeout"""
.el .SS "\f(CWconnect_timeout\fP"
.IX Subsection "connect_timeout"
Unlike most \s-1HTTP\s0 backends, Hijk accepts a separate \f(CW\*(C`connect_timeout\*(C'\fR
parameter, which defaults to \f(CW2\fR seconds but can be reduced in an
environment with low network latency.
.SS "Inherited configuration"
.IX Subsection "Inherited configuration"
From Search::Elasticsearch::Role::Cxn
.IP "\(bu" 4
node
.IP "\(bu" 4
max_content_length
.IP "\(bu" 4
deflate
.IP "\(bu" 4
deflate
.IP "\(bu" 4
request_timeout
.IP "\(bu" 4
ping_timeout
.IP "\(bu" 4
dead_timeout
.IP "\(bu" 4
max_dead_timeout
.IP "\(bu" 4
sniff_request_timeout
.IP "\(bu" 4
sniff_timeout
.IP "\(bu" 4
handle_args
.IP "\(bu" 4
handle_args
.SH "SSL/TLS"
.IX Header "SSL/TLS"
Search::Elasticsearch::Cxn::Hijk does not support \s-1HTTPS.\s0
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """perform_request()"""
.el .SS "\f(CWperform_request()\fP"
.IX Subsection "perform_request()"
.Vb 5
\&    ($status,$body) = $self\->perform_request({
\&        # required
\&        method      => \*(AqGET|HEAD|POST|PUT|DELETE\*(Aq,
\&        path        => \*(Aq/path/of/request\*(Aq,
\&        qs          => \e%query_string_params,
\&
\&        # optional
\&        data        => $body_as_string,
\&        mime_type   => \*(Aqapplication/json\*(Aq,
\&        timeout     => $timeout
\&    });
.Ve
.PP
Sends the request to the associated Elasticsearch node and returns
a \f(CW$status\fR code and the decoded response \f(CW$body\fR, or throws an
error if the request failed.
.SS "Inherited methods"
.IX Subsection "Inherited methods"
From Search::Elasticsearch::Role::Cxn
.IP "\(bu" 4
\&\fBscheme()\fR
.IP "\(bu" 4
\&\fBis_https()\fR
.IP "\(bu" 4
\&\fBuserinfo()\fR
.IP "\(bu" 4
\&\fBdefault_headers()\fR
.IP "\(bu" 4
\&\fBmax_content_length()\fR
.IP "\(bu" 4
\&\fBbuild_uri()\fR
.IP "\(bu" 4
\&\fBhost()\fR
.IP "\(bu" 4
\&\fBport()\fR
.IP "\(bu" 4
\&\fBuri()\fR
.IP "\(bu" 4
\&\fBis_dead()\fR
.IP "\(bu" 4
\&\fBis_live()\fR
.IP "\(bu" 4
\&\fBnext_ping()\fR
.IP "\(bu" 4
\&\fBping_failures()\fR
.IP "\(bu" 4
\&\fBmark_dead()\fR
.IP "\(bu" 4
\&\fBmark_live()\fR
.IP "\(bu" 4
\&\fBforce_ping()\fR
.IP "\(bu" 4
\&\fBpings_ok()\fR
.IP "\(bu" 4
\&\fBsniff()\fR
.IP "\(bu" 4
\&\fBprocess_response()\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Search::Elasticsearch::Role::Cxn
.IP "\(bu" 4
Search::Elasticsearch::Cxn::HTTPTiny
.IP "\(bu" 4
Search::Elasticsearch::Cxn::LWP
.IP "\(bu" 4
Search::Elasticsearch::Cxn::NetCurl
.SH "AUTHOR"
.IX Header "AUTHOR"
Enrico Zimuel <enrico.zimuel@elastic.co>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2020 by Elasticsearch \s-1BV.\s0
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Apache License, Version 2.0, January 2004
.Ve