MAN page from Mandrake Other ldap-devel-3.3-3.i386.rpm

LDAP_CACHE

Section: C Library Functions (3)
Updated: 14 November 1994
Index

NAME

ldap_enable_cache, ldap_disable_cache, ldap_destroy_cache, ldap_flush_cache, ldap_uncache_entry, ldap_uncache_request, ldap_set_cache_options - LDAP client caching routines

SYNOPSIS

#include <lber.h>#include <ldap.h>ldap_enable_cache( ld, timeout, maxmem )LDAP    *ld;long    timeout;long    maxmem;void ldap_disable_cache( ld )LDAP    *ld;void ldap_destroy_cache( ld )LDAP    *ld;void ldap_flush_cache( ld )LDAP    *ld;void ldap_uncache_entry( ld, dn )LDAP    *ld;char    *dn;void ldap_uncache_request( ld, msgid )LDAP    *ld;int     msgid;void ldap_set_cache_options( ld, opts )LDAP            *ld;unsigned long   opts;

DESCRIPTION

These routines are used to control the behavior of client caching ofldap_search(3),cldap_search_s(3),andldap_compare(3)operations. Bydefault, the cache is disabled and no caching is done. Enabling thecache can greatly improve performance and reduce network bandwidth whena client DUA makes repeated requests.

ldap_enable_cache()should be called to turn on local caching or tochange cache parameters (lifetime of cached requests and memory used).The ld parameter should be the result of a successful call toldap_open(3).The timeout is specified in seconds, and is used todecide how long to keep cached requests. The maxmem value is inbytes, and is used to set an upper bound on how memory the cache willuse. You can specify 0 for maxmem to restrict the cache size bythe timeout only. The first call to ldap_enable_cache createsthe cache; subsequent calls re-enable the cache and set the timeout andmemory values.

ldap_disable_cache()temporarily disables use of the cache (newrequests are not cached and the cache is not checked when returningresults). It does not delete the cache contents.

ldap_destroy_cache()turns off caching and completely removes the cache from memory.

ldap_flush_cache()deletes the cache contents, but does not effect it in any other way.

ldap_uncache_entry()removes all requests that make reference to thedistinguished name dn from the cache. It should be used, forexample, after doing anldap_modify(3)call involving dn.

ldap_uncache_request()removes the request indicated by the LDAP requestid msgid from the cache.

ldap_set_cache_options()is used to change caching behavior. The current supported options areLDAP_CACHE_OPT_CACHENOERRSto suppress caching of any requests that result in an error, andLDAP_CACHE_OPT_CACHEALLERRSto enable caching of all requests. The default behavior is to notcache requests that result in errors, except that request that resultin the errorLDAP_SIZELIMIT_EXCEEDEDare cached.

ERRORS

ldap_enable_cache()returns 0 upon success, and -1 if it is unable toallocate space for the cache. All the other calls are declared asvoid and return nothing.

This document was created byman2html,using the manual pages.