.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::LDAP::Control::SyncRequest 3"
.TH Net::LDAP::Control::SyncRequest 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::LDAP::Control::SyncRequest \- LDAPv3 Sync Request control object
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 6
\& use Net::LDAP;
\& use Net::LDAP::Control::SyncRequest;
\& use Net::LDAP::Constant qw(
\&  LDAP_SYNC_REFRESH_ONLY
\&  LDAP_SYNC_REFRESH_AND_PERSIST
\&  LDAP_SUCCESS );
\&
\& $ldap = Net::LDAP\->new( "ldap.mydomain.eg" );
\&
\& $req = Net::LDAP::Control::SyncRequest\->new( mode => LDAP_SYNC_REFRESH_ONLY );
\& my $mesg = $ldap\->search(base=> \*(Aqdc=mydomain,dc=\*(Aqeg\*(Aq,
\&                          scope    => \*(Aqsub\*(Aq,
\&                          control  => [ $req ],
\&                          callback => \e&searchCallback, # call for each entry
\&                          filter   => "(objectClass=*)",
\&                          attrs    => [ \*(Aq*\*(Aq]);
\& sub searchCallback {
\&   my $message = shift;
\&   my $entry = shift;
\&   my @controls = $message\->control;
\&
\&   if ($controls[0]\->isa(\*(AqNet::LDAP::Control::SyncState\*(Aq)) {
\&     print "Received Sync State Control\en";
\&     print $entry\->dn()."\en";
\&     print \*(AqState: \*(Aq.$controls[0]\->state."\en".\*(Aq, entryUUID: \*(Aq.$controls[0]\->entryUUID.\*(Aq, cookie: \*(Aq.$controls[0]\->cookie;
\&   } elsif ($controls[0]\->isa(\*(AqNet::LDAP::Control::SyncDone\*(Aq)) {
\&     print "Received Sync Done Control\en";
\&     print \*(AqCookie: \*(Aq.$controls[0]\->cookie.\*(Aq, refreshDeletes: \*(Aq.$controls[0]\->refreshDeletes;
\&   }
\& }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::LDAP::Control::SyncRequest\*(C'\fR provides an interface for the creation and
manipulation of objects that represent the \f(CW\*(C`Sync Request Control\*(C'\fR as described
by RFC 4533.
.SH "CONSTRUCTOR ARGUMENTS"
.IX Header "CONSTRUCTOR ARGUMENTS"
In addition to the constructor arguments described in
Net::LDAP::Control the following are provided.
.IP mode 4
.IX Item "mode"
.PD 0
.IP cookie 4
.IX Item "cookie"
.IP reloadHint 4
.IX Item "reloadHint"
.PD
.SH METHODS
.IX Header "METHODS"
As with Net::LDAP::Control each constructor argument
described above is also available as a method on the object which will
return the current value for the attribute if called without an argument,
and set a new value for the attribute if called with an argument.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::LDAP,
Net::LDAP::Control,
Net::LDAP::Control::SyncState,
Net::LDAP::Control::SyncDone,
http://www.ietf.org/rfc/rfc4533.txt
.SH AUTHOR
.IX Header "AUTHOR"
Mathieu Parent <math.parent@gmail.com>
.PP
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
<perl\-ldap@perl.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2008 Mathieu Parent. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.