GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  SEARCH::ELASTICSEARCH::CXN::HTTPTINY (3)

.ds Aq ’

NAME

Search::Elasticsearch::Cxn::HTTPTiny - A Cxn implementation which uses HTTP::Tiny

CONTENTS

VERSION

version 2.00

DESCRIPTION

Provides the default HTTP Cxn class and is based on HTTP::Tiny. The HTTP::Tiny backend is fast, uses pure Perl, support proxies and https and provides persistent connections.

This class does Search::Elasticsearch::Role::Cxn::HTTP, whose documentation provides more information, Search::Elasticsearch::Role::Cxn and Search::Elasticsearch::Role::Is_Sync.

CONFIGURATION

    Inherited configuration

From Search::Elasticsearch::Role::Cxn::HTTP
o node
o max_content_length
o deflate
From Search::Elasticsearch::Role::Cxn
o request_timeout
o ping_timeout
o dead_timeout
o max_dead_timeout
o sniff_request_timeout
o sniff_timeout
o handle_args
o handle_args

SSL/TLS

Search::Elasticsearch::Cxn::HTTPTiny uses IO::Socket::SSL to support HTTPS. By default, no validation of the remote host is performed.

This behaviour can be changed by passing the ssl_options parameter with any options accepted by IO::Socket::SSL. For instance, to check that the remote host has a trusted certificate, and to avoid man-in-the-middle attacks, you could do the following:



    use Search::Elasticsearch;
    use IO::Socket::SSL;

    my $es = Search::Elasticsearch->new(
        nodes => [
            "https://node1.mydomain.com:9200",
            "https://node2.mydomain.com:9200",
        ],
        ssl_options => {
            SSL_verify_mode     => SSL_VERIFY_PEER,
            SSL_ca_file         => /path/to/cacert.pem
        }
    );



If the remote server cannot be verified, an Search::Elasticsearch::Error will be thrown.

If you want your client to present its own certificate to the remote server, then use:



    use Search::Elasticsearch;
    use IO::Socket::SSL;

    my $es = Search::Elasticsearch->new(
        nodes => [
            "https://node1.mydomain.com:9200",
            "https://node2.mydomain.com:9200",
        ],
        ssl_options => {
            SSL_verify_mode     => SSL_VERIFY_PEER,
            SSL_use_cert        => 1,
            SSL_ca_file         => /path/to/cacert.pem,
            SSL_cert_file       => /path/to/client.pem,
            SSL_key_file        => /path/to/client.pem,
        }
    );



METHODS

CWperform_request()



    ($status,$body) = $self->perform_request({
        # required
        method      => GET|HEAD|POST|PUT|DELETE,
        path        => /path/of/request,
        qs          => \%query_string_params,

        # optional
        data        => $body_as_string,
        mime_type   => application/json,
        timeout     => $timeout
    });



Sends the request to the associated Elasticsearch node and returns a $status code and the decoded response $body, or throws an error if the request failed.

    Inherited methods

From Search::Elasticsearch::Role::Cxn::HTTP
o scheme()
o is_https()
o userinfo()
o default_headers()
o max_content_length()
o build_uri()
From Search::Elasticsearch::Role::Cxn
o host()
o port()
o uri()
o is_dead()
o is_live()
o next_ping()
o ping_failures()
o mark_dead()
o mark_live()
o force_ping()
o pings_ok()
o sniff()
o process_response()

SEE ALSO

o Search::Elasticsearch::Role::Cxn::HTTP
o Search::Elasticsearch::Cxn::Hijk
o Search::Elasticsearch::Cxn::LWP
o Search::Elasticsearch::Cxn::NetCurl

AUTHOR

Clinton Gormley <drtech@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2015 by Elasticsearch BV.

This is free software, licensed under:



  The Apache License, Version 2.0, January 2004



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 SEARCH::ELASTICSEARCH::CXN::HTTPTINY (3) 2015-10-28

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.