How to: Add an Object to Cache (Velocity)

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

The following examples show the ways you can add objects to the cache. These procedures assume that you have already set up your cache cluster and have prepared your development environment to write cache-enabled applications. For more information about how to do this, see Installation and Deployment (Velocity) and How to: Prepare the Development Environment (Velocity).

For more details about the methods that are used in these examples, follow these links to view the class library topics:

Data in the cache is not encrypted and is available to any cache client with the appropriate configuration settings. We highly recommend that you secure the XML-based application configuration files, if used, to specify the cache client.

To add an object to cache

  1. Make sure that the using statement (Imports in Visual Basic) is at the top of your application code to reference the Microsoft.Data.Caching namespace.

  2. Create a DataCacheFactory object that is accessible to all parts of the application that need a cache client. We recommend reusing the same DataCacheFactory object to conserve memory and optimize performance.

  3. Use the DataCacheFactory object to create a DataCache object (also referred to as the cache client) if you have not already done this. In the following examples, the DataCacheFactory instance is called CacheFactory1.

  4. After you have the DataCache object, the Add method, Put method, or Item property may be called to add an object to the cache.

Example

The following example demonstrates how you can use the Add method to add an object to cache. You will get an exception if an object has already been cached by the same key (the first parameter).

Note

There are many other parameters available for this method. See the Add class library for more information.

'add object to cache with key "Key0"
myCache.Add("Key0", "object added with Key0")
//add object to cache with key "Key0"
myCache.Add("Key0", "object added with Key0");

The following example uses the Put method to add an object to cache. If an object has already been cached by the same key, it will be replaced.

Note

There are many other parameters available for this method. See the Put class library for more information.

'add or replace object in cache using key "Key0"
myCache.Put("Key0", "object replaced or added using Key0")
//add or replace object in cache using key "Key0"
myCache.Put("Key0", "object replaced or added using Key0");

The following example uses the Item property that has array notation to add an item to the cache. If an object has already been cached by the same key, it will be replaced.

'add or replace object in cache using array notation
myCache("Key0") = "object replaced or added using Key0"
//add or replace object in cache using array notation
myCache["Key0"] = "object replaced or added using Key0";

See Also

Tasks

How to: Prepare the Development Environment (Velocity)
How to: Update an Object in Cache (Velocity)
How to: Get an Object from Cache (Velocity)
How to: Remove an Object from Cache (Velocity)

Other Resources

Installation and Deployment (Velocity)
Cache Concepts (Velocity)
Programming Guide (Velocity)