Apache Ignite.NET
Apache.Ignite.Core.IIgnite Interface Reference

Main entry point for all Ignite APIs. You can obtain an instance of IGrid through Ignition.GetIgnite(), or for named grids you can use Ignition.GetIgnite(string). Note that you can have multiple instances of IGrid running in the same process by giving each instance a different name. All members are thread-safe and may be used concurrently from multiple threads. More...

Inheritance diagram for Apache.Ignite.Core.IIgnite:

Public Member Functions

ICluster GetCluster ()
 Gets an instance of ICluster interface. More...
 
ICompute GetCompute ()
 Gets compute functionality over this grid projection. All operations on the returned ICompute instance will only include nodes from this projection. More...
 
ICache< TK, TV > GetCache< TK, TV > (string name)
 Gets the cache instance for the given name to work with keys and values of specified types. You can get instances of ICache of the same name, but with different key/value types. These will use the same named cache, but only allow working with entries of specified types. Attempt to retrieve an entry of incompatible type will result in InvalidCastException. Use GetCache<TK,TV> in order to work with entries of arbitrary types. More...
 
ICache< TK, TV > GetOrCreateCache< TK, TV > (string name)
 Gets existing cache with the given name or creates new one using template configuration. More...
 
ICache< TK, TV > CreateCache< TK, TV > (string name)
 Dynamically starts new cache using template configuration. More...
 
IDataStreamer< TK, TV > GetDataStreamer< TK, TV > (string cacheName)
 Gets a new instance of data streamer associated with given cache name. Data streamer is responsible for loading external data into Ignite. For more information refer to IDataStreamer<K,V> documentation. More...
 
IBinary GetBinary ()
 Gets an instance of IBinary interface. More...
 
ICacheAffinity GetAffinity (string name)
 Gets affinity service to provide information about data partitioning and distribution. More...
 
ITransactions GetTransactions ()
 Gets Ignite transactions facade. More...
 
IMessaging GetMessaging ()
 Gets messaging facade over all cluster nodes. More...
 
IEvents GetEvents ()
 Gets events facade over all cluster nodes. More...
 
IServices GetServices ()
 Gets services facade over all cluster nodes. More...
 
IAtomicLong GetAtomicLong (string name, long initialValue, bool create)
 Gets an atomic long with specified name from cache. Creates new atomic long in cache if it does not exist and create is true. More...
 

Properties

string Name [get]
 Gets the name of the grid this Ignite instance (and correspondingly its local node) belongs to. Note that single process can have multiple Ignite instances all belonging to different grids. Grid name allows to indicate to what grid this particular Ignite instance (i.e. Ignite runtime and its local node) belongs to. If default Ignite instance is used, then null is returned. Refer to Ignition documentation for information on how to start named grids. More...
 

Detailed Description

Member Function Documentation

ICache<TK, TV> Apache.Ignite.Core.IIgnite.CreateCache< TK, TV > ( string  name)
Template Parameters
TKCache key type.
TVCache value type.
Parameters
nameCache name.
Returns
Existing or newly created cache.
ICacheAffinity Apache.Ignite.Core.IIgnite.GetAffinity ( string  name)
Parameters
nameCache name.
Returns
Cache data affinity service.
IAtomicLong Apache.Ignite.Core.IIgnite.GetAtomicLong ( string  name,
long  initialValue,
bool  create 
)
Parameters
nameName of the atomic long.
initialValueInitial value for the atomic long. Ignored if create is false.
createFlag indicating whether atomic long should be created if it does not exist.
Returns
Atomic long instance with specified name, or null if it does not exist and create flag is not set.
Exceptions
IgniteExceptionIf atomic long could not be fetched or created.
IBinary Apache.Ignite.Core.IIgnite.GetBinary ( )
Returns
Instance of IBinary interface
ICache<TK, TV> Apache.Ignite.Core.IIgnite.GetCache< TK, TV > ( string  name)
Parameters
nameCache name.
Returns
Cache instance for given name.
Template Parameters
TKCache key type.
TVCache value type.
ICluster Apache.Ignite.Core.IIgnite.GetCluster ( )
ICompute Apache.Ignite.Core.IIgnite.GetCompute ( )
Returns
Compute instance over this grid projection.
IDataStreamer<TK, TV> Apache.Ignite.Core.IIgnite.GetDataStreamer< TK, TV > ( string  cacheName)
Parameters
cacheNameCache name (null for default cache).
Returns
Data streamer.
IEvents Apache.Ignite.Core.IIgnite.GetEvents ( )
Returns
Events facade over all cluster nodes.
IMessaging Apache.Ignite.Core.IIgnite.GetMessaging ( )
Returns
Messaging instance over all cluster nodes.
ICache<TK, TV> Apache.Ignite.Core.IIgnite.GetOrCreateCache< TK, TV > ( string  name)
Template Parameters
TKCache key type.
TVCache value type.
Parameters
nameCache name.
Returns
Existing or newly created cache.
IServices Apache.Ignite.Core.IIgnite.GetServices ( )
Returns
Services facade over all cluster nodes.
ITransactions Apache.Ignite.Core.IIgnite.GetTransactions ( )

Property Documentation

string Apache.Ignite.Core.IIgnite.Name
get
Returns
Name of the grid, or null for default grid.