PeanutButter.TempElasticsearch.ITempElasticsearchFactory Interface Reference

Describes a factory for your http server usage: More...

Inheritance diagram for PeanutButter.TempElasticsearch.ITempElasticsearchFactory:

Properties
TempElasticSearchOptions	Options [get]
	The options to use when providing a new TempElasticsearch.
Properties inherited from PeanutButter.Utils.IPool< 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.

Additional Inherited Members
Public Member Functions inherited from PeanutButter.Utils.IPool< T >
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.
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.
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.
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.
void	Warmup ()
	Causes an initial temporary elasticsearch instance to be started, and gates the next request for an instance.
void	Dispose ()
	Disposes of this pool and all items in the pool.

Detailed Description

Describes a factory for your http server usage:

• Take() an IPoolItem<IHttpServer>
• work with the server
• return it to the pool by disposing of the pool item (use 'using' for safety)

Property Documentation

Options

TempElasticSearchOptions PeanutButter.TempElasticsearch.ITempElasticsearchFactory.Options

get

The options to use when providing a new TempElasticsearch.

Implemented in PeanutButter.TempElasticsearch.TempElasticsearchFactory.

---

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

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