PeanutButter.TempRedis.TempRedisFactory Class Reference

More...

Inheritance diagram for PeanutButter.TempRedis.TempRedisFactory:

Public Member Functions
	TempRedisFactory ()
	Instantiates a new TempRedis factory with default options.
	TempRedisFactory (TempRedisOptions redisOptions)
	Instantiates a new TempRedis factory where new instances are created with the provided options.
Public Member Functions inherited from PeanutButter.Utils.Pool< ITempRedis >
	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 ()
IPoolItem< T >	Take (int maxWaitMilliseconds)
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	Warmup ()
void	Forget (IPoolItem< T > item)
void	Dispose ()
	Disposes of this pool and all items in the pool.
Public Member Functions inherited from PeanutButter.Utils.IPool< ITempRedis >
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.

Additional Inherited Members
Properties inherited from PeanutButter.Utils.Pool< ITempRedis >
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.
Properties inherited from PeanutButter.Utils.IPool< ITempRedis >
int	MaxItems [get]
	The maximum number of items to hold in the pool.
int	Count [get]
	How many items are currently in the pool.

Detailed Description

Constructor & Destructor Documentation

TempRedisFactory()

PeanutButter.TempRedis.TempRedisFactory.TempRedisFactory

(

TempRedisOptions

redisOptions

)

Instantiates a new TempRedis factory where new instances are created with the provided options.

Parameters

redisOptions

---

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

• source/TempDb/PeanutButter.TempRedis/TempRedisFactory.cs