1Net::LDAP::Control::PerUssiesrteCnotnSterairbcuht(e3d)PNeertl::DLoDcAuPm:e:nCtoanttiroonl::PersistentSearch(3)
2
3
4

NAME

6       Net::LDAP::Control::PersistentSearch - LDAPv3 Persistent Search control
7       object
8

SYNOPSIS

10        use Net::LDAP;
11        use Net::LDAP::Control::PersistentSearch;
12
13        $ldap = Net::LDAP->new( "ldap.mydomain.eg" );
14
15        $persist = Net::LDAP::Control::PersistentSearch->new( changeTypes => 15,
16                                                              changesOnly => 1,
17                                                              returnECs => 1 );
18
19        $srch = $ldap->search( base     => "cn=People,dc=mydomain,dc=eg",
20                               filter   => "(objectClass=person)",
21                               callback => \&process_entry, # call for each entry
22                               control  => [ $persist ] );
23
24        die "error: ",$srch->code(),": ",$srch->error()  if ($srch->code());
25
26        sub process_entry {
27          my $message = shift;
28          my $entry = shift;
29
30          print $entry->dn()."\n";
31        }
32

DESCRIPTION

34       "Net::LDAP::Control::PersistentSearch" provides an interface for the
35       creation and manipulation of objects that represent the
36       "PersistentSearch" control as described by
37       draft-smith-psearch-ldap-01.txt.
38

CONSTRUCTOR ARGUMENTS

40       In addition to the constructor arguments described in
41       Net::LDAP::Control the following are provided.
42
43       changeTypes
44           An integer value determining the types of changes to look out for.
45           It is the bitwise OR of the following values (which represent the
46           LDAP operations indicated next to them):
47
48           1 = add
49           2 = delete
50           4 = modify
51           8 = modDN
52
53           If it is not given it defaults to 15 meaning all changes.
54
55       changesOnly
56           A boolean value telling whether the server may return entries that
57           match the search criteria.
58
59           If "TRUE" the server must not return return any existing entries
60           that match the search criteria.  Entries are only returned when
61           they are changed (added, modified, deleted, or subject to a
62           modifyDN operation)
63
64       returnECs
65           If "TRUE", the server must return an Entry Change Notification
66           control with each entry returned as the result of changes.
67
68           See Net::LDAP::Control::EntryChange for details.
69

METHODS

71       As with Net::LDAP::Control each constructor argument described above is
72       also available as a method on the object which will return the current
73       value for the attribute if called without an argument, and set a new
74       value for the attribute if called with an argument.
75

SEE ALSO

77       Net::LDAP, Net::LDAP::Control, Net::LDAP::Control::EntryChange
78

AUTHOR

80       Peter Marschall <peter@adpm.de>, based on Net::LDAP::Control::Page from
81       Graham Barr <gbarr@pobox.com> and the preparatory work of Don Miller
82       <donm@uidaho.edu>.
83
84       Please report any bugs, or post any suggestions, to the perl-ldap
85       mailing list <perl-ldap@perl.org>
86

88       Copyright (c) 2004 Peter Marschall. All rights reserved. This program
89       is free software; you can redistribute it and/or modify it under the
90       same terms as Perl itself.
91
92
93
94perl v5.12.0                      2010-0N3e-t1:2:LDAP::Control::PersistentSearch(3)
Impressum