bionic (3) Search::Elasticsearch::CxnPool::Static::NoPing.3pm.gz

Provided by: libsearch-elasticsearch-perl_5.01-1_all bug

NAME

       Search::Elasticsearch::CxnPool::Static::NoPing - A CxnPool for connecting to a remote cluster without the
       ability to ping.

VERSION

       version 5.01

SYNOPSIS

           $e = Search::Elasticsearch->new(
               cxn_pool => 'Static::NoPing'
               nodes    => [
                   'search1:9200',
                   'search2:9200'
               ],
           );

DESCRIPTION

       The Static::NoPing connection pool (like the Static pool) should be used when your access to the cluster
       is limited.  However, the "Static" pool needs to be able to ping nodes in the cluster, with a "HEAD /"
       request.  If you can't ping your nodes, then you should use the "Static::NoPing" connection pool instead.

       Because the cluster cannot be pinged, this CxnPool cannot use a short ping request to determine whether
       nodes are live or not - it just has to send requests to the nodes to determine whether they are alive or
       not.

       Most of the time, a dead node will cause the request to fail quickly.  However, in situations where node
       failure takes time (eg malfunctioning routers or firewalls), a failure may not be reported until the
       request itself times out (see "request_timeout" in Search::Elasticsearch::Cxn).

       Failed nodes will be retried regularly to check if they have recovered.

       This class does Search::Elasticsearch::Role::CxnPool::Static::NoPing and
       Search::Elasticsearch::Role::Is_Sync.

CONFIGURATION

   "nodes"
       The list of nodes to use to serve requests.  Can accept a single node, multiple nodes, and defaults to
       "localhost:9200" if no "nodes" are specified. See "node" in Search::Elasticsearch::Role::Cxn for details
       of the node specification.

   See also
       •   "request_timeout" in Search::Elasticsearch::Role::Cxn

       •   "dead_timeout" in Search::Elasticsearch::Role::Cxn

       •   "max_dead_timeout" in Search::Elasticsearch::Role::Cxn

   Inherited configuration
       From Search::Elasticsearch::Role::CxnPool::Static::NoPing

       •   max_retries

       From Search::Elasticsearch::Role::CxnPool

       •   randomize_cxns

METHODS

   "next_cxn()"
           $cxn = $cxn_pool->next_cxn

       Returns the next available node  in round robin fashion - either a live node which has previously
       responded successfully, or a previously failed node which should be retried. If all nodes are dead, it
       will throw a "NoNodes" error.

   Inherited methods
       From Search::Elasticsearch::Role::CxnPool::Static::NoPing

       •   should_mark_dead()schedule_check()

       From Search::Elasticsearch::Role::CxnPool

       •   cxn_factory()logger()serializer()current_cxn_num()cxns()seed_nodes()next_cxn_num()set_cxns()request_ok()request_failed()should_retry()should_mark_dead()cxns_str()cxns_seeds_str()retries()reset_retries()

AUTHOR

       Clinton Gormley <drtech@cpan.org>

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

       This is free software, licensed under:

         The Apache License, Version 2.0, January 2004