NAME
ldap_cache, 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 functions
SYNOPSIS
cc[ flag... ] file... -lldap[ library... ]
#include <lber.h>
#include <ldap.h>
ldap_enable_cache(LDAP *ld, long timeout, long maxmem);
void ldap_disable_cache(LDAP *ld);
void ldap_destroy_cache(LDAP *ld);
void ldap_flush_cache(LDAP *ld);
void ldap_uncache_entry(LDAP *ld, char *dn);
void ldap_uncache_request(LDAP *ld, int msgid);
void ldap_set_cache_options(LDAP *ld, unsigned long opts);
DESCRIPTION
These functions are used to control the behavior of client
caching of ldap_search(3LDAP), cldap_search_s(3LDAP), and
ldap_compare(3LDAP) operations. By default, the cache is
disabled and no caching is done. Enabling the cache can
greatly improve performance and reduce network bandwidth
when a client DUA makes repeated requests.
ldap_enable_cache() should be called to turn on local cach-
ing or to change cache parameters (lifetime of cached
requests and memory used). The ld parameter should be the
result of a successful call to ldap_open(3LDAP). The timeout
is specified in seconds, and is used to decide how long to
keep cached requests. The maxmem value is in bytes, and is
used to set an upper bound on how memory the cache will use.
You can specify 0 for maxmem to restrict the cache size by
the timeout only. The first call to ldap_enable_cache
creates the cache; subsequent calls re-enable the cache and
set the timeout and memory values.
ldap_disable_cache() temporarily disables use of the cache
(new requests are not cached and the cache is not checked
when returning results). It does not delete the cache con-
tents.
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 refer-
ence to the distinguished name dn from the cache. It should
be used, for example, after doing an ldap_modify(3LDAP) call
involving dn.
ldap_uncache_request() removes the request indicated by the
LDAP request id msgid from the cache.
ldap_set_cache_options() is used to change caching behavior.
The current supported options are LDAP_CACHE_OPT_CACHENOERRS
to suppress caching of any requests that result in an error,
and LDAP_CACHE_OPT_CACHEALLERRS to enable caching of all
requests. The default behavior is to not cache requests
that result in errors, except that request that result in
the error LDAP_SIZELIMIT_EXCEEDED are cached.
ERRORS
ldap_enable_cache() returns 0 upon success, and -1 if it
is unable to allocate space for the cache. All the other
calls are declared as void and return nothing.
ATTRIBUTES
See attributes(5) for a description of the following attri-
butes:
____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | SUNWlldap (32-bit) |
|_____________________________|_____________________________|
| | SUNWldapx (64-bit) |
|_____________________________|_____________________________|
| Stability Level | Evolving |
|_____________________________|_____________________________|
SEE ALSO
ldap(3LDAP), ldap_search(3LDAP), ldap_compare(3LDAP),
cldap_search_s(3LDAP)
|
Закладки на сайте Проследить за страницей |
Created 1996-2025 by Maxim Chirkov Добавить, Поддержать, Вебмастеру |