Public Member Functions | Properties | List of all members
GridGain.IGrid Interface Reference

Main entry point for all GridGain APIs. You can obtain an instance of IGrid through GridFactory.Grid(), or for named grids you can use GridFactory.Grid(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...

Inherits IDisposable.

Public Member Functions

ICompute Compute ()
 Gets compute functionality over this grid projection. All operations on the returned ICompute instance will only include nodes from this projection. More...
 
ICompute Compute (IClusterGroup clusterGroup)
 Gets compute functionality over specified grid projection. All operations on the returned ICompute instance will only include nodes from that projection. More...
 
ICache< K, V > Cache< K, V > (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 Cache<Object, Object> in order to work with entries of arbitrary types. More...
 
ICache< K, V > GetOrCreateCache< K, V > (string name)
 Gets existing cache with the given name or creates new one using template configuration. More...
 
ICache< K, V > CreateCache< K, V > (string name)
 Dynamically starts new cache using template configuration. More...
 
IDataStreamer< K, V > DataStreamer< K, V > (string cacheName)
 Gets a new instance of data streamer associated with given cache name. Data streamer is responsible for loading external data into in-memory data grid. For more information refer to IDataStreamer<K,V> documentation. More...
 
IPortables Portables ()
 Gets an instance of IPortables interface. More...
 
ICacheAffinity Affinity (string name)
 Gets affinity service to provide information about data partitioning and distribution. More...
 
IMessaging Message ()
 Gets messaging facade over all cluster nodes. More...
 
IMessaging Message (IClusterGroup clusterGroup)
 Gets messaging facade over nodes within the cluster group. All operations on the returned IMessaging> instance will only include nodes from the specified cluster group. More...
 
IEvents Events ()
 Gets events facade over all cluster nodes. More...
 
IEvents Events (IClusterGroup clusterGroup)
 Gets events facade over nodes within the cluster group. All operations on the returned IEvents> instance will only include nodes from the specified cluster group. More...
 
IServices Services ()
 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 grid instance (and correspondingly its local node) belongs to. Note that single process can have multiple grid instances all belonging to different grids. Grid name allows to indicate to what grid this particular grid instance (i.e. grid runtime and its local node) belongs to. If default grid instance is used, then null is returned. Refer to GridFactory documentation for information on how to start named grids. More...
 
ICluster Cluster [get]
 Gets an instance of ICluster interface. More...
 
ITransactions Transactions [get]
 Gets grid transactions facade. More...
 
ISecurity Security [get]
 Gets grid security facade. More...
 
IProduct Product [get]
 Gets information about product and license management capabilities. More...
 
IDataCenterReplication DataCenterReplication [get]
 Gets an instance of Data Center Replication. More...
 

Detailed Description

Member Function Documentation

ICacheAffinity GridGain.IGrid.Affinity ( string  name)
Parameters
nameCache name.
Returns
Cache data affinity service.
ICache<K, V> GridGain.IGrid.Cache< K, V > ( string  name)
Parameters
nameCache name.
Returns
Cache instance for given name.
Template Parameters
KCache key type.
VCache value type.
ICompute GridGain.IGrid.Compute ( )
Returns
Compute instance over this grid projection.
ICompute GridGain.IGrid.Compute ( IClusterGroup  clusterGroup)
Returns
Compute instance over specified grid projection.
ICache<K, V> GridGain.IGrid.CreateCache< K, V > ( string  name)
Template Parameters
KCache key type.
VCache value type.
Parameters
nameCache name.
Returns
Existing or newly created cache.
IDataStreamer<K, V> GridGain.IGrid.DataStreamer< K, V > ( string  cacheName)
Parameters
cacheNameCache name (null for default cache).
Returns
Data streamer.
IEvents GridGain.IGrid.Events ( )
Returns
Events facade over all cluster nodes.
IEvents GridGain.IGrid.Events ( IClusterGroup  clusterGroup)
Parameters
clusterGroupCluster group.
Returns
Events instance over given cluster group.
IAtomicLong GridGain.IGrid.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.
ICache<K, V> GridGain.IGrid.GetOrCreateCache< K, V > ( string  name)
Template Parameters
KCache key type.
VCache value type.
Parameters
nameCache name.
Returns
Existing or newly created cache.
IMessaging GridGain.IGrid.Message ( )
Returns
Messaging instance over all cluster nodes.
IMessaging GridGain.IGrid.Message ( IClusterGroup  clusterGroup)
Parameters
clusterGroupCluster group.
Returns
Messaging instance over given cluster group.
IPortables GridGain.IGrid.Portables ( )
Returns
Instance of IPortables interface
IServices GridGain.IGrid.Services ( )
Returns
Services facade over all cluster nodes.

Property Documentation

ICluster GridGain.IGrid.Cluster
get
IDataCenterReplication GridGain.IGrid.DataCenterReplication
get
string GridGain.IGrid.Name
get
Returns
Name of the grid, or null for default grid.
IProduct GridGain.IGrid.Product
get
ISecurity GridGain.IGrid.Security
get
ITransactions GridGain.IGrid.Transactions
get