PeanutButter.TempElasticsearch.TempElasticsearchFactory Class Reference

More...

Inheritance diagram for PeanutButter.TempElasticsearch.TempElasticsearchFactory:

Public Member Functions
	TempElasticsearchFactory ()
	Constructs a new TempElasticsearchFactory with no limit on the total number of servers that can be in play.
	TempElasticsearchFactory (int maxItems)
	Constructs a new TempElasticsearchFactory with the provided item limit.
	TempElasticsearchFactory (int maxItems, TempElasticSearchOptions options)
	Constructs a new TempElasticsearchFactory with the provided item limit and options for creating new instances of TempElasticsearch.
Public Member Functions inherited from PeanutButter.Utils.Pool< T >
	Pool (Func< T > factory)
	Creates the pool with a factory for the items.
	Pool (Func< T > factory, int maxItems)
	Creates the pool with a factory for the items.
	Pool (Func< T > factory, Action< T > onRelease)
	Creates the pool with the provided factory and an action to run on releasing the item.
	Pool (Func< T > factory, Action< T > onRelease, int maxItems)
	Creates the pool with the provided factory and an action to run on releasing the item.
	Pool (Func< IPool< T >, T > factory)
	Creates the pool with a factory for the items.
	Pool (Func< IPool< T >, T > factory, int maxItems)
	Creates the pool with a factory for the items.
	Pool (Func< IPool< T >, T > factory, Action< T > onRelease)
	Creates the pool with the provided factory and an action to run on releasing the item.
	Pool (Func< IPool< T >, T > factory, Action< T > onRelease, int maxItems)
	Creates the pool with the provided factory and an action to run on releasing the item.
IPoolItem< T >	Take ()
	Attempt to take an item from the pool. If possible and required, an item will be created for you. If the pool is full and no item can be made available, this will a pool item with a null instance. Returns
IPoolItem< T >	Take (int maxWaitMilliseconds)
	Attempt to take an item from the pool, with a max wait in ms when the pool is already full and you need to wait on something else to release an instance. If no instance can be found in time, then this will return a PoolItem with a default instance. Parameters maxWaitMilliseconds Returns
IPoolItem< T >	Borrow ()
	Attempt to take an item from the pool. If possible and required, an item will be created for you. If the pool is full and no item can be made available, this will a pool item with a null instance.
void	Warmup ()
	Causes an initial temporary elasticsearch instance to be started, and gates the next request for an instance.
IPoolItem< T >	Borrow (int maxWaitMilliseconds)
	Attempt to take an item from the pool, with a max wait in ms when the pool is already full and you need to wait on something else to release an instance. If no instance can be found in time, then this will return a PoolItem with a default instance.
void	Forget (IPoolItem< T > item)
	Forget the item from the pool. Parameters item
void	Dispose ()
	Disposes of this pool and all items in the pool.

Properties
TempElasticSearchOptions	Options [get]
	The options to use when providing a new TempElasticsearch.
Properties inherited from PeanutButter.Utils.Pool< T >
int	MaxItems [get]
	The maximum number of items to hold in the pool.
int	Count [get]
	How many items are currently in the pool.
bool	WarmupStarted [get]
	Set when warmup starts.
bool	WarmedUp [get, set]
	Set when warmup completes.

Detailed Description

Property Documentation

Options

TempElasticSearchOptions PeanutButter.TempElasticsearch.TempElasticsearchFactory.Options

get

The options to use when providing a new TempElasticsearch.

• since each instance makes a read-only copy of this at launch, this is fairly safe to be modified, if you need to, otherwise construct with the required options

Implements PeanutButter.TempElasticsearch.ITempElasticsearchFactory.

---

The documentation for this class was generated from the following file:

• source/TempDb/PeanutButter.TempElasticsearch/TempElasticsearchFactory.cs