sh.waitForPingChange.txt

======================
sh.waitForPingChange()
======================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. method:: sh.waitForPingChange(activePings, timeout, interval)

   :method:`sh.waitForPingChange()` waits for a change in ping state
   of one of the ``activepings``, and only returns when the specified
   ping changes state.


   .. list-table::
      :header-rows: 1
      :widths: 20 20 80
   
      * - Parameter
   
        - Type
   
        - Description
   
      * - ``activePings``
   
        - array
   
        - An array of active pings from the :data:`~config.mongos` collection.
          
          
   
      * - ``timeout``
   
        - integer
   
        - Number of milliseconds to wait for a change in ping state.
          
          
   
      * - ``interval``
   
        - integer
   
        - Number of milliseconds to sleep in each waiting cycle.
          
Compatibility
-------------

This method is available in deployments hosted in the following environments: 

.. include:: /includes/fact-environments-no-atlas-support.rst

.. include:: /includes/fact-environments-onprem-only.rst