ignite::Ignite Class Reference

Main interface to operate with Ignite. More...

#include <ignite.h>

Public Member Functions
	Ignite ()
	Default constructor.
	Ignite (impl::IgniteImpl *impl)
	Constructor.
const char *	GetName () const
	Get Ignite instance name. More...
template<typename K , typename V >
cache::Cache< K, V >	GetCache (const char *name)
	Get cache. More...
template<typename K , typename V >
cache::Cache< K, V >	GetCache (const char *name, IgniteError *err)
	Get cache. More...
template<typename K , typename V >
cache::Cache< K, V >	GetOrCreateCache (const char *name)
	Get or create cache. More...
template<typename K , typename V >
cache::Cache< K, V >	GetOrCreateCache (const char *name, IgniteError *err)
	Get or create cache. More...
template<typename K , typename V >
cache::Cache< K, V >	CreateCache (const char *name)
	Create cache. More...
template<typename K , typename V >
cache::Cache< K, V >	CreateCache (const char *name, IgniteError *err)
	Create cache. More...
transactions::Transactions	GetTransactions ()
	Get transactions. More...
bool	IsValid () const
	Check if the instance is valid. More...

Friends
class	impl::IgniteImpl

Detailed Description

Main interface to operate with Ignite.

This class implemented as a reference to an implementation so copying of this class instance will only create another reference to the same underlying object. Underlying object released automatically once all the instances are destructed.

Member Function Documentation

template<typename K , typename V >

cache::Cache<K, V> ignite::Ignite::CreateCache ( const char *  name )

inline

Create cache.

This method should only be used on the valid instance.

Parameters

name	Cache name.

Returns

Cache.

template<typename K , typename V >

cache::Cache<K, V> ignite::Ignite::CreateCache ( const char *  name, IgniteError *  err  )

inline

Create cache.

This method should only be used on the valid instance.

Parameters

name	Cache name.
err	Error;

Returns

Cache.

template<typename K , typename V >

cache::Cache<K, V> ignite::Ignite::GetCache ( const char *  name )

inline

Get cache.

This method should only be used on the valid instance.

Parameters

name	Cache name.

Returns

Cache.

template<typename K , typename V >

cache::Cache<K, V> ignite::Ignite::GetCache ( const char *  name, IgniteError *  err  )

inline

Get cache.

This method should only be used on the valid instance.

Parameters

name	Cache name.
err	Error;

Returns

Cache.

const char * ignite::Ignite::GetName

(

)

const

Get Ignite instance name.

Returns

Name.

template<typename K , typename V >

cache::Cache<K, V> ignite::Ignite::GetOrCreateCache ( const char *  name )

inline

Get or create cache.

This method should only be used on the valid instance.

Parameters

name	Cache name.

Returns

Cache.

template<typename K , typename V >

cache::Cache<K, V> ignite::Ignite::GetOrCreateCache ( const char *  name, IgniteError *  err  )

inline

Get or create cache.

This method should only be used on the valid instance.

Parameters

name	Cache name.
err	Error;

Returns

Cache.

transactions::Transactions ignite::Ignite::GetTransactions

(

)

Get transactions.

This method should only be used on the valid instance.

Returns

Transaction class instance.

bool ignite::Ignite::IsValid ( ) const

inline

Check if the instance is valid.

Invalid instance can be returned if some of the previous operations have resulted in a failure. For example invalid instance can be returned by not-throwing version of method in case of error. Invalid instances also often can be created using default constructor.

Returns

True if the instance is valid and can be used.

---

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

• ignite.h
• ignite.cpp