All Implemented Interfaces:

ai.platon.pulsar.common.config.Parameterized , java.lang.AutoCloseable
```
public class WebDriverPoolManager
extends PreemptChannelSupport implements Parameterized, AutoCloseable
                    
```
The web driver pool manager.
The web driver pool manager provides web drivers to run web page fetch tasks.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`WebDriverPoolManager.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`isActive`
`private final Boolean`	`isReady`
`private final Duration`	`idleTimeout`
`private final Map<BrowserId, LoadingWebDriverPool>`	`workingDriverPools`
`private final Map<BrowserId, LoadingWebDriverPool>`	`retiredDriverPools`
`private final Set<BrowserId>`	`closedDriverPools`
`private final Instant`	`startTime`
`private Instant`	`lastActiveTime`
`private final Duration`	`idleTime`
`private final Boolean`	`isIdle`
`private final <Error class: unknown class>`	`numWaitingTasks`
`private final <Error class: unknown class>`	`numStandbyDrivers`
`private final <Error class: unknown class>`	`numWorkingDrivers`
`private final <Error class: unknown class>`	`numAvailableDriverSlots`
`private final <Error class: unknown class>`	`numActiveDrivers`
`private final <Error class: unknown class>`	`numDyingDrivers`
`private final Integer`	`numClosedDrivers`
`private final Integer`	`maxAllowedDyingDrivers`
`private final <Error class: unknown class>`	`numReset`
`private final <Error class: unknown class>`	`numTimeout`
`private final <Error class: unknown class>`	`gauges`
`private final BrowserManager`	`browserManager`
`private final BrowserFactory`	`browserFactory`
`private final ImmutableConfig`	`immutableConfig`
`private final Boolean`	`suppressMetrics`
`private final Boolean`	`hasEvent`
`private final Boolean`	`isNormal`
`private final Boolean`	`isPreempted`
`private final String`	`name`
`public final static WebDriverPoolManager.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`WebDriverPoolManager(BrowserManager browserManager, BrowserFactory browserFactory, ImmutableConfig immutableConfig, Boolean suppressMetrics)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`isActive()`
`final Boolean`	`isReady()`
`final Duration`	`getIdleTimeout()`
`final Map<BrowserId, LoadingWebDriverPool>`	`getWorkingDriverPools()`
`final Map<BrowserId, LoadingWebDriverPool>`	`getRetiredDriverPools()`
`final Set<BrowserId>`	`getClosedDriverPools()`
`final Instant`	`getStartTime()`
`final Instant`	`getLastActiveTime()`
`final Unit`	`setLastActiveTime(Instant lastActiveTime)`
`final Duration`	`getIdleTime()`
`final Boolean`	`isIdle()`
`final <Error class: unknown class>`	`getNumWaitingTasks()`
`final <Error class: unknown class>`	`getNumStandbyDrivers()`
`final <Error class: unknown class>`	`getNumWorkingDrivers()`
`final <Error class: unknown class>`	`getNumAvailableDriverSlots()`
`final <Error class: unknown class>`	`getNumActiveDrivers()`
`final <Error class: unknown class>`	`getNumDyingDrivers()`
`final Integer`	`getNumClosedDrivers()`
`final Integer`	`getMaxAllowedDyingDrivers()`	Maximum allowed number of dying drives, if it's exceeded, the oldest driver pool should be closed.
`final <Error class: unknown class>`	`getNumReset()`
`final <Error class: unknown class>`	`getNumTimeout()`
`final <Error class: unknown class>`	`getGauges()`
`final BrowserManager`	`getBrowserManager()`
`final BrowserFactory`	`getBrowserFactory()`
`final ImmutableConfig`	`getImmutableConfig()`
`final Boolean`	`getSuppressMetrics()`
`final Boolean`	`hasPossibility(BrowserId browserId)`	Check if the browser has possibility to serve tasks.
`final Integer`	`promisedDriverCount(BrowserId browserId)`	Get the number of drivers which can serve tasks in the pool.
`final Boolean`	`hasDriverPromise(BrowserId browserId)`	Check if the pool has at least one driver to serve.
`final Boolean`	`isFullCapacity(BrowserId browserId)`	Check if the pool is on full capacity.
`final WebDriver`	`subscribeDriver(BrowserId browserId)`	Subscribe a web driver in the pool specified by browserId, the other subscriber should not use the driver.
`final WebDriver`	`subscribeDriver()`	Subscribe a web driver, the other subscriber should not use the driver.
`final <Error class: unknown class>`	`isRetiredPool(BrowserId browserId)`	Check if a pool is retired.
`final FetchResult`	`run(BrowserId browserId, FetchTask task, SuspendFunction1<WebDriver, FetchResult> browseFun)`	reactor: tell me if you can do this job pro-actor: here is a job, tell me if you finished it
`final FetchResult`	`run(WebDriverTask task)`	Run the task.
`final Boolean`	`isActivePool(BrowserId browserId)`	Check if a pool is retired.
`final WebDriver`	`cancel(String url)`	Cancel the fetch task specified by url remotely.
`final WebDriver`	`cancel(BrowserId browserId, String url)`	Cancel the fetch task specified by url remotely.
`final Unit`	`cancelAll()`	Cancel all the fetch tasks, stop loading all pages.
`final Unit`	`cancelAll(BrowserId browserId)`	Cancel all the fetch tasks, stop loading all pages.
`final LoadingWebDriverPool`	`createUnmanagedDriverPool(BrowserId browserId)`	Create a driver pool, but the driver pool is not added to workingDriverPools.
`final Unit`	`closeBrowserAccompaniedDriverPoolGracefully(BrowserId browserId, Duration timeToWait)`	Find the driver pool with browserId, cancel all running tasks in it, and close all drivers in it.
`final Unit`	`maintain(Boolean force)`	Maintain all the driver pools, check and report inconsistency, illness, idleness, etc., close bad pools if necessary.
`final String`	`buildStatusString(BrowserId browserId, Boolean verbose)`	Take a snapshot about the state of the driver pools.
`final String`	`buildStatusString(Boolean verbose)`	Take a snapshot about the state of the driver pools.
`Unit`	`close()`	Close the web driver pool manager.
`String`	`toString()`	Return a string to represent the snapshot of the status.

Methods inherited from class ai.platon.pulsar.common.concurrent.PreemptChannelSupport
formatPreemptChannelStatus, getHasEvent, getName, isNormal, isPreempted, preempt, releaseLocks, whenNormal, whenNormalDeferred
Methods inherited from class ai.platon.pulsar.common.config.Parameterized
getParams
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebDriverPoolManager
```
WebDriverPoolManager(BrowserManager browserManager, BrowserFactory browserFactory, ImmutableConfig immutableConfig, Boolean suppressMetrics)
```
- Method Detail
  - isActive
```
 final Boolean isActive()
```
  - isReady
```
 final Boolean isReady()
```
  - getIdleTimeout
```
 final Duration getIdleTimeout()
```
  - getWorkingDriverPools
```
 final Map<BrowserId, LoadingWebDriverPool> getWorkingDriverPools()
```
  - getRetiredDriverPools
```
 final Map<BrowserId, LoadingWebDriverPool> getRetiredDriverPools()
```
  - getClosedDriverPools
```
 final Set<BrowserId> getClosedDriverPools()
```
  - getStartTime
```
 final Instant getStartTime()
```
  - getLastActiveTime
```
 final Instant getLastActiveTime()
```
  - setLastActiveTime
```
 final Unit setLastActiveTime(Instant lastActiveTime)
```
  - getIdleTime
```
 final Duration getIdleTime()
```
  - isIdle
```
 final Boolean isIdle()
```
  - getNumWaitingTasks
```
 final <Error class: unknown class> getNumWaitingTasks()
```
  - getNumStandbyDrivers
```
 final <Error class: unknown class> getNumStandbyDrivers()
```
  - getNumWorkingDrivers
```
 final <Error class: unknown class> getNumWorkingDrivers()
```
  - getNumAvailableDriverSlots
```
 final <Error class: unknown class> getNumAvailableDriverSlots()
```
  - getNumActiveDrivers
```
 final <Error class: unknown class> getNumActiveDrivers()
```
  - getNumDyingDrivers
```
 final <Error class: unknown class> getNumDyingDrivers()
```
  - getNumClosedDrivers
```
 final Integer getNumClosedDrivers()
```
  - getMaxAllowedDyingDrivers
```
 final Integer getMaxAllowedDyingDrivers()
```
    Maximum allowed number of dying drives, if it's exceeded, the oldest driver pool should be closed. Dying drivers are kept for diagnosis.
  - getNumReset
```
 final <Error class: unknown class> getNumReset()
```
  - getNumTimeout
```
 final <Error class: unknown class> getNumTimeout()
```
  - getGauges
```
 final <Error class: unknown class> getGauges()
```
  - getBrowserManager
```
 final BrowserManager getBrowserManager()
```
  - getBrowserFactory
```
 final BrowserFactory getBrowserFactory()
```
  - getImmutableConfig
```
 final ImmutableConfig getImmutableConfig()
```
  - getSuppressMetrics
```
 final Boolean getSuppressMetrics()
```
  - hasPossibility
```
 final Boolean hasPossibility(BrowserId browserId)
```
    Check if the browser has possibility to serve tasks.
    the browser is not in any pool
    the browser is in the working pool
    Parameters:
    
    browserId - the browser id
  - promisedDriverCount
```
 final Integer promisedDriverCount(BrowserId browserId)
```
    Get the number of drivers which can serve tasks in the pool.
  - hasDriverPromise
```
 final Boolean hasDriverPromise(BrowserId browserId)
```
    Check if the pool has at least one driver to serve.
  - isFullCapacity
```
 final Boolean isFullCapacity(BrowserId browserId)
```
    Check if the pool is on full capacity.
  - subscribeDriver
```
@Beta() final WebDriver subscribeDriver(BrowserId browserId)
```
    Subscribe a web driver in the pool specified by browserId, the other subscriber should not use the driver.
  - subscribeDriver
```
@Beta() final WebDriver subscribeDriver()
```
    Subscribe a web driver, the other subscriber should not use the driver.
  - isRetiredPool
```
 final <Error class: unknown class> isRetiredPool(BrowserId browserId)
```
    Check if a pool is retired.
  - run
```
 final FetchResult run(BrowserId browserId, FetchTask task, SuspendFunction1<WebDriver, FetchResult> browseFun)
```
    reactor: tell me if you can do this job pro-actor: here is a job, tell me if you finished it
    
    Returns:
    
    The result of action, or null if timeout
  - run
```
 final FetchResult run(WebDriverTask task)
```
    Run the task.
  - isActivePool
```
 final Boolean isActivePool(BrowserId browserId)
```
    Check if a pool is retired.
  - cancel
```
 final WebDriver cancel(String url)
```
    Cancel the fetch task specified by url remotely. NOTE: A cancel request should run immediately not waiting for any browser task return.
  - cancel
```
 final WebDriver cancel(BrowserId browserId, String url)
```
    Cancel the fetch task specified by url remotely. NOTE: A cancel request should run immediately not waiting for any browser task return.
  - cancelAll
```
 final Unit cancelAll()
```
    Cancel all the fetch tasks, stop loading all pages.
  - cancelAll
```
 final Unit cancelAll(BrowserId browserId)
```
    Cancel all the fetch tasks, stop loading all pages.
  - createUnmanagedDriverPool
```
 final LoadingWebDriverPool createUnmanagedDriverPool(BrowserId browserId)
```
    Create a driver pool, but the driver pool is not added to workingDriverPools.
  - closeBrowserAccompaniedDriverPoolGracefully
```
 final Unit closeBrowserAccompaniedDriverPoolGracefully(BrowserId browserId, Duration timeToWait)
```
    Find the driver pool with browserId, cancel all running tasks in it, and close all drivers in it. When we close a driver pool, all threads that are trying to get a driver should wait. When the driver pool is closed, all the drivers in it will be closed, and the browser associated with the driver pool will be closed as well.
  - maintain
```
 final Unit maintain(Boolean force)
```
    Maintain all the driver pools, check and report inconsistency, illness, idleness, etc., close bad pools if necessary.
    If "takeDriverPoolSnapshot" is in file AppPaths.PATH_LOCAL_COMMAND, perform the action.
    If the tmp dir is the default one, run the following command to take snapshot once: echo takeDriverPoolSnapshot /tmp/pulsar/pulsar-commands
  - buildStatusString
```
 final String buildStatusString(BrowserId browserId, Boolean verbose)
```
    Take a snapshot about the state of the driver pools.
  - buildStatusString
```
 final String buildStatusString(Boolean verbose)
```
    Take a snapshot about the state of the driver pools.
  - close
```
 Unit close()
```
    Close the web driver pool manager. All deferred tasks will be canceled, the pool of driver pools will be cleared and the browser manager will be closed.
    It happens when the program exits.
    The closing call stack:
    PrivacyContextManager.close -> PrivacyContext.close -> WebDriverContext.close -> WebDriverPoolManager.close -> BrowserManager.close -> Browser.close -> WebDriver.close |-> LoadingWebDriverPool.close
  - toString
```
 String toString()
```
    Return a string to represent the snapshot of the status.

Class WebDriverPoolManager

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class ai.platon.pulsar.common.concurrent.PreemptChannelSupport

Methods inherited from class ai.platon.pulsar.common.config.Parameterized

Methods inherited from class java.lang.Object

Constructor Detail

WebDriverPoolManager

Method Detail

isActive

isReady

getIdleTimeout

getWorkingDriverPools

getRetiredDriverPools

getClosedDriverPools

getStartTime

getLastActiveTime

setLastActiveTime

getIdleTime

isIdle

getNumWaitingTasks

getNumStandbyDrivers

getNumWorkingDrivers

getNumAvailableDriverSlots

getNumActiveDrivers

getNumDyingDrivers

getNumClosedDrivers

getMaxAllowedDyingDrivers

getNumReset

getNumTimeout

getGauges

getBrowserManager

getBrowserFactory

getImmutableConfig

getSuppressMetrics

hasPossibility

promisedDriverCount

hasDriverPromise

isFullCapacity

subscribeDriver

subscribeDriver

isRetiredPool

run

run

isActivePool

cancel

cancel

cancelAll

cancelAll

createUnmanagedDriverPool

closeBrowserAccompaniedDriverPoolGracefully

maintain

buildStatusString

buildStatusString

close

toString