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

CLDAP_SEARCH_S

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

NAME

cldap_search_s - Connectionless LDAP Search

SYNOPSIS

#include <lber.h>#include <ldap.h>int cldap_search_s( ld, base, scope, filter, attrs, attrsonly,        res, logdn )LDAP *ld;char *base;int scope;char *filter;char **attrs;int attrsonly;LDAPMessage **res;char *logdn;

DESCRIPTION

Thecldap_search_s()routine performs an LDAP search using theConnectionless LDAP (CLDAP) protocol.

cldap_search_s()has parameters and behavior identical to that ofldap_search_s(3),except for the addition of the logdnparameter. logdn should contain a distinguished name to be used onlyfor logging purposed by the LDAP server. It should be in the textformat described by RFC 1779 "A String Representation of Distinguished Names".

RETRANSMISSION ALGORITHM

cldap_search_s()operates using the CLDAP protocol overudp(4p).Since UDP is a non-reliable protocol, a retry mechanism is used to increasereliability. Thecldap_setretryinfo(3)routine can be used to set tworetry parameters: tries, a count of the number of times to senda search request and timeout, an initial timeout that determineshow long to wait for a response before re-trying. timeout isspecified seconds. These values are stored in the ld_cldaptries andld_cldaptimeout members of the ld LDAP structure, and thedefault values set inldap_open(3)are 4 and 3 respectively. The retransmission algorithm used is:

Step 1. Set the current timeout to ld_cldaptimeout seconds, andthe current LDAP server address to the first LDAP server found duringtheldap_open(3)call.

Step 2: Send the search request to the current LDAP server address.

Step 3: Set the wait timeout to the current timeout divided by thenumber of server addresses found duringldap_open(3)or to onesecond, whichever is larger. Wait at most that long for a response; ifa response is received, STOP. Note that the wait timeout is always roundeddown to the next lowest second.

Step 5: Repeat steps 2 and 3 for each LDAP server address.

Step 6: Set the current timeout to twice its previous value and repeatSteps 2 through 6 a maximum of tries times.

RETRANSMISSION EXAMPLE

Assume that the default values for tries and timeout of4 tries and 3 seconds are used. Further, assume that a space-separatedlist of two hosts, each with one address, was passed tocldap_open(3).The pattern of requests sent will be (stopping as soon as a response isreceived):

  Time          Search Request Sent To:   +0                   Host A try 1   +1  (0+3/2)          Host B try 1   +2  (1+3/2)          Host A try 2   +5  (2+6/2)          Host B try 2   +8  (5+6/2)          Host A try 3   +14 (8+12/2)         Host B try 3   +20 (14+12/2)        Host A try 4   +32 (20+24/2)        Host B try 4   +44 (20+24/2)        (give up - no response)

ERRORS

cldap_search_s()returns LDAP_SUCCESS if a search was successful and theappropriate LDAP error code otherwise. Seeldap_error(3)for more information.

This document was created byman2html,using the manual pages.