Table of Contents | Previous | Next | Index

Netscape Directory SDK 3.0 for C Programmer’s Guide
Chapter 17 Data Types and Structures

LDAPMemCache

LDAPMemCache is a type of structure representing an in-memory, client-side cache.

You can create a cache and specify the following information:

the maximum size of the cache

the maximum amount of time to keep an item in the cache

a set of base DNs for the search requests that you want to cache (optional)

a set of functions that you want used to ensure the thread-safety of the cache

To use a cache, you need to associate it with a connection handle (and LDAP structure). Before a search request is sent to the server, the cache is checked to determine if the same request was made before. If an earlier request was cached, the search results are retrieved from the cache.

Note that the cache uses the search criteria as the key to cached items. Search requests with different criteria are cached as separate items.

For example, suppose you send a search request specifying that you just want to retrieve the uid attribute. Your client caches the results of that search. If you send a similar search request specifying that you want to retrieve all attributes instead of just the uid, the results cached from the previous search are not used.

the cache uses a combination of the following information as the key to a cached item:

the hostname and port number of the LDAP server that you are searching

the DN that you are currently authenticated as

from the search criteria, the base DN, scope, filter, attributes to be returned, and an indication of whether to return attribute types only or attribute types and values

Use the following functions to work with the cache:

To create an LDAPMemCache structure, call the ldap_memcache_init() function.

To associate an LDAPMemCache structure with a connection handle (an LDAP structure), call the ldap_memcache_set() function.

To get the LDAPMemCache structure that is associated with a connection handle (an LDAP structure), call the ldap_memcache_get() function.

To get the cache to proactively remove expired items, call the ldap_memcache_update() function.

To remove entries from the cache, call the ldap_memcache_flush() function.

To free the LDAPMemCache structure, call the ldap_memcache_destroy() function.

Table of Contents | Previous | Next | Index

Last Updated: 10/01/98 17:05:28