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 WebDriverSettings`	`driverSettings`
`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 Integer`	`numWaitingTasks`
`private final Integer`	`numStandbyDrivers`
`private final Integer`	`numWorkingDrivers`
`private final Integer`	`numAvailableDriverSlots`
`private final Integer`	`numActiveDrivers`
`private final Integer`	`numDyingDrivers`
`private final Integer`	`numClosedDrivers`
`private final Integer`	`maxAllowedDyingDrivers`
`private final Meter`	`numReset`
`private final Meter`	`numTimeout`
`private final Map<String, Gauge<out Object>>`	`gauges`
`private final BrowserManager`	`browserManager`
`private final WebDriverFactory`	`driverFactory`
`private final ImmutableConfig`	`immutableConfig`
`private final Boolean`	`suppressMetrics`
`private final Boolean`	`hasEvent`
`private final Boolean`	`isNormal`
`private final Boolean`	`isPreempted`
`private final String`	`name`

Constructor Summary

Constructors
Constructor	Description
`WebDriverPoolManager(BrowserManager browserManager, WebDriverFactory driverFactory, ImmutableConfig immutableConfig, Boolean suppressMetrics)`

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getIsActive()`
`final Boolean`	`getIsReady()`
`final WebDriverSettings`	`getDriverSettings()`
`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`	`getIsIdle()`
`final Integer`	`getNumWaitingTasks()`
`final Integer`	`getNumStandbyDrivers()`
`final Integer`	`getNumWorkingDrivers()`
`final Integer`	`getNumAvailableDriverSlots()`
`final Integer`	`getNumActiveDrivers()`
`final Integer`	`getNumDyingDrivers()`
`final Integer`	`getNumClosedDrivers()`
`final Integer`	`getMaxAllowedDyingDrivers()`
`final Meter`	`getNumReset()`
`final Meter`	`getNumTimeout()`
`final Map<String, Gauge<out Object>>`	`getGauges()`
`final BrowserManager`	`getBrowserManager()`
`final WebDriverFactory`	`getDriverFactory()`
`final ImmutableConfig`	`getImmutableConfig()`
`final Boolean`	`getSuppressMetrics()`
`final Boolean`	`getHasEvent()`
`final Boolean`	`getIsNormal()`
`final Boolean`	`getIsPreempted()`
`final String`	`getName()`
`final FetchResult`	`run(FetchTask task, SuspendFunction1<WebDriver, FetchResult> browseFun)`	Run the task.
`final FetchResult`	`run(BrowserId browserId, FetchTask task, SuspendFunction1<WebDriver, FetchResult> browseFun)`	TODO: consider pro-actor model insteadreactor: tell me if you can do this job pro-actor: here is a job, tell me if you finished it
`final Unit`	`run(Integer driverId, FetchTask task, SuspendFunction1<WebDriver, FetchResult> browseFun)`	Run the task with the driver specified.
`final FetchResult`	`run(WebDriverTask task)`	Run the task.
`final FetchResult`	`runCancelable(WebDriverTask task, WebDriver driver)`	Run the task and save the execution state, so it can be canceled by cancel and cancelAll.
`final LoadingWebDriverPool`	`createUnmanagedDriverPool(BrowserId browserId, Integer priority)`	Create a driver pool, but the driver pool is not added to workingDriverPools.
`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 Boolean`	`isRetiredPool(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 Unit`	`closeDriverPoolGracefully(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()`	Maintain all the driver pools, check and report inconsistency, illness, idleness, etc., close bad pools if necessary.
`final String`	`takeSnapshot(BrowserId browserId, Boolean verbose)`	Take a snapshot about the state of the driver pools.
`final String`	`takeSnapshot(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.protocol.browser.driver.WebDriverPoolManager
formatPreemptChannelStatus, getParams, preempt, releaseLocks, whenNormal, whenNormalDeferred
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WebDriverPoolManager
```
WebDriverPoolManager(BrowserManager browserManager, WebDriverFactory driverFactory, ImmutableConfig immutableConfig, Boolean suppressMetrics)
```
- Method Detail
  - getIsActive
```
 final Boolean getIsActive()
```
  - getIsReady
```
 final Boolean getIsReady()
```
  - getDriverSettings
```
 final WebDriverSettings getDriverSettings()
```
  - 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()
```
  - getIsIdle
```
 final Boolean getIsIdle()
```
  - getNumWaitingTasks
```
 final Integer getNumWaitingTasks()
```
  - getNumStandbyDrivers
```
 final Integer getNumStandbyDrivers()
```
  - getNumWorkingDrivers
```
 final Integer getNumWorkingDrivers()
```
  - getNumAvailableDriverSlots
```
 final Integer getNumAvailableDriverSlots()
```
  - getNumActiveDrivers
```
 final Integer getNumActiveDrivers()
```
  - getNumDyingDrivers
```
 final Integer getNumDyingDrivers()
```
  - getNumClosedDrivers
```
 final Integer getNumClosedDrivers()
```
  - getMaxAllowedDyingDrivers
```
 final Integer getMaxAllowedDyingDrivers()
```
  - getNumReset
```
 final Meter getNumReset()
```
  - getNumTimeout
```
 final Meter getNumTimeout()
```
  - getGauges
```
 final Map<String, Gauge<out Object>> getGauges()
```
  - getBrowserManager
```
 final BrowserManager getBrowserManager()
```
  - getDriverFactory
```
 final WebDriverFactory getDriverFactory()
```
  - getImmutableConfig
```
 final ImmutableConfig getImmutableConfig()
```
  - getSuppressMetrics
```
 final Boolean getSuppressMetrics()
```
  - getHasEvent
```
 final Boolean getHasEvent()
```
  - getIsNormal
```
 final Boolean getIsNormal()
```
  - getIsPreempted
```
 final Boolean getIsPreempted()
```
  - getName
```
 final String getName()
```
  - run
```
 final FetchResult run(FetchTask task, SuspendFunction1<WebDriver, FetchResult> browseFun)
```
    Run the task.
  - run
```
 final FetchResult run(BrowserId browserId, FetchTask task, SuspendFunction1<WebDriver, FetchResult> browseFun)
```
    TODO: consider pro-actor model instead
    reactor: tell me if you can do this job pro-actor: here is a job, tell me if you finished it
  - run
```
 final Unit run(Integer driverId, FetchTask task, SuspendFunction1<WebDriver, FetchResult> browseFun)
```
    Run the task with the driver specified.
  - run
```
 final FetchResult run(WebDriverTask task)
```
    Run the task.
  - runCancelable
```
 final FetchResult runCancelable(WebDriverTask task, WebDriver driver)
```
    Run the task and save the execution state, so it can be canceled by cancel and cancelAll.
  - createUnmanagedDriverPool
```
 final LoadingWebDriverPool createUnmanagedDriverPool(BrowserId browserId, Integer priority)
```
    Create a driver pool, but the driver pool is not added to workingDriverPools.
  - 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 Boolean isRetiredPool(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.
  - closeDriverPoolGracefully
```
 final Unit closeDriverPoolGracefully(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.
  - maintain
```
 final Unit maintain()
```
    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
  - takeSnapshot
```
 final String takeSnapshot(BrowserId browserId, Boolean verbose)
```
    Take a snapshot about the state of the driver pools.
  - takeSnapshot
```
 final String takeSnapshot(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

Method Summary

Methods inherited from class ai.platon.pulsar.protocol.browser.driver.WebDriverPoolManager

Methods inherited from class java.lang.Object

Constructor Detail

WebDriverPoolManager

Method Detail

getIsActive

getIsReady

getDriverSettings

getIdleTimeout

getWorkingDriverPools

getRetiredDriverPools

getClosedDriverPools

getStartTime

getLastActiveTime

setLastActiveTime

getIdleTime

getIsIdle

getNumWaitingTasks

getNumStandbyDrivers

getNumWorkingDrivers

getNumAvailableDriverSlots

getNumActiveDrivers

getNumDyingDrivers

getNumClosedDrivers

getMaxAllowedDyingDrivers

getNumReset

getNumTimeout

getGauges

getBrowserManager

getDriverFactory

getImmutableConfig

getSuppressMetrics

getHasEvent

getIsNormal

getIsPreempted

getName

run

run

run

run

runCancelable

createUnmanagedDriverPool

promisedDriverCount

hasDriverPromise

isFullCapacity

subscribeDriver

subscribeDriver

isRetiredPool

cancel

cancel

cancelAll

cancelAll

closeDriverPoolGracefully

maintain

takeSnapshot

takeSnapshot

close

toString