Getting started tutorial lesson 2.2: Creating a .NET client application

To insert, delete, update, and retrieve data from your data grid, you must write a client application. The getting started sample includes a .NET client application that you can use to learn about creating your own client application.

1. Connect to the catalog service by obtaining a IClientConnectionContext instance.

   To connect to the catalog server, use the Connect method of the IGridManager API.

   IGridManager gm = GridManagerFactory.GetGridManager( );
   ICatalogDomainInfo cdi = gm.CatalogDomainManager.CreateCatalogDomainInfo( endpoint );
   ccc = gm.Connect( cdi, "SimpleClient.properties" );

   If the connection to the catalog server succeeds, the Connect method returns a IClientConnectionContext instance. The IClientConnectionContext instance is required to obtain the data grid from the IGridManager API.
2. Obtain an ObjectGrid instance.

   To obtain an ObjectGrid instance, use the GetGrid method of the IGridManager API. The GetGrid method requires both the IClientConnectionContext instance and the name of the data grid instance. The IClientConnectionContext instance is obtained during the connection to the catalog server. The name of data grid instance is the grid that is specified in the objectgrid.xml file.

   grid = gm.GetGrid( ccc, gridName );

3. Get a map instance.

   You can get a map instance by calling the GetGridMapPessimisticTx method of the IGrid API. Pass the name of the map as parameter to the GetGridMapPessimisticTx method to get the map instance.

   pessMap = grid.GetGridMapPessimisticTx<Object, Object>( mapName );

4. Use the IGridMapPessimisticTx methods.

   After a map instance is obtained, you can use the IGridMapPessimisticTx API.

   The following code snippet demonstrates how to use the IGridMapPessimisticTx API.

   • To begin a transaction with the IGridMapPessimisticTx API, you must call the map.Transaction.Begin() method. This method starts a new transaction in which you can run operations.

     case "begin":
        map.Transaction.Begin( );
        return 0;

   • The add method inserts a new key/value pair . If the key currently exists, then an exception is thrown.

      case "a":
        if( key == null ) throw new MissingParameterException( "key" );
        if( value == null ) throw new MissingParameterException( "value" );
        map.Add( key, value );
        Console.WriteLine( "SUCCESS: Added key '{0}' with value '{1}', 
        partitionId={2}", key, value, partitionId );
        return 0;

   • The put method inserts or updates a key/value pair.

     case "p":
       if( key == null ) throw new MissingParameterException( "key" );
       if( value == null ) throw new MissingParameterException( "value" );
       map.Put( key, value );
       Console.WriteLine( "SUCCESS: Put key '{0}' with value '{1}', 
       partitionId={2}", key, value, partitionId );
       return 0;

   • The replace method replaces an existing key/value pair. If the item is not present, then an exception is thrown.

     case "r":
       if( key == null ) throw new MissingParameterException( "key" );
       if( value == null ) throw new MissingParameterException( "value" );
       map.Replace( key, value );
       Console.WriteLine( "SUCCESS: Replaced key '{0}' with value '{1}', 
       partitionId={2}", key, value, partitionId );
       return 0;

   • The remove method deletes a key/value pair.

     case "d":
       if( key == null ) throw new MissingParameterException( "key" );
       map.Remove( key );
       Console.WriteLine( "SUCCESS: Deleted value with key '{0}', 
       partitionId={1}", key, partitionId );
     	  return 0;

   • The get method retrieves the value for the given key.

      case "g":
       if( key == null ) throw new MissingParameterException( "key" );
       value = ( TestValue )map.Get( key );
       if( value != null )
       {
         Console.WriteLine( "SUCCESS: Value is '{0}', 
       partitionId={1}", value, partitionId );
       }
       else
       {
         Console.WriteLine( "FAILED: Key not found" );
       }
       return 0;

   • If you want to cancel the operations that you performed in the operation before you commit, use the rollback method.

     case "rollback":
       map.Transaction.Rollback( );
       return 0;

   • The commit method commits the operations that completed in the transaction.

     case "commit":
       map.Transaction.Commit( );
       return 0;