IJavaScriptEnginePool Interface

Summary

Provides a shared pool of JavaScript engine instances. You should dispose the pool when no longer needed to properly dispose of any allocated engines.
Assembly
Wyam.Common.dll
Namespace
Wyam.Common.JavaScript
Interfaces
  • IDisposable
graph BT Type-.->Interface0["IDisposable"] Type["IJavaScriptEnginePool"] class Type type-node

Syntax

public interface IJavaScriptEnginePool : IDisposable

Properties

Name Value Summary
AvailableEngineCount int
Gets the number of currently available engines in this engine pool.
EngineCount int
Gets the total number of engines in this engine pool, including engines that are currently busy.

Methods

Name Value Summary
DisposeEngine(IJavaScriptEngine, bool) void
Disposes the specified engine.
GetEngine(Nullable<TimeSpan>) IJavaScriptEngine
Gets an engine from the pool. This engine should be disposed when you are finished with it. If an engine is free, this method returns immediately with the engine. If no engines are available but we have not reached the maximum number of engines yet, creates a new engine. If the maximum number of engines has been reached, blocks until an engine is available again.
Recycle() void
Disposes all engines in this pool, and creates new engines in their place.
GitHub