Net::LD...:Cancel(3)

🌸 NAME 🌸

Net::LDAP::Extension::Cancel β€” LDAP Cancel Operation. ok so this is the manual page for Net::LD...:Cancel(3) from the User Contributed Perl Documentation, and the actual module is Net::LDAP::Extension::Cancel. iconic, honestly πŸ’–

✨ SYNOPSIS ✨

use Net::LDAP;
use Net::LDAP::Constant qw(LDAP_SUCCESS LDAP_CANCELED)
use Net::LDAP::Extension::Cancel;

$ldap = Net::LDAP->new( 'ldap.mydomain.eg' );

$ldap->bind('cn=Joe User,cn=People,dc=example,dc=com',
            password => 'secret');

$search = $ldap->search(
                       base     => 'c=US',
                       filter   => '(&(sn=Barr) (o=Texas Instruments))',
                       callback => \&process_entry, # Call this sub for each entry
                     );

$mesg = $ldap->cancel($search);

die "error :", $mesg->code(), ": ", $mesg->error()
  if ($mesg->code() != LDAP_CANCELED && mesg->code() != LDAP_SUCCESS);

πŸ’… DESCRIPTION πŸ’…

Net::LDAP::Extension::Cancel implements the Cancel extended LDAPv3 operation as described in RFC 3909. no cap, that's the whole assignment πŸ”₯

The Cancel extended operation is very similar to the Abandon standard operation, and has the same call signature. but unlike the Abandon operation, it has a response which provides an indication of its outcome. so you actually get the tea back, bestie β˜•βœ¨

It implements no object by itself but extends the Net::LDAP object by another method: 🫢

πŸ› οΈ METHODS πŸ› οΈ

cancel ( OPERATION, OPTIONS )

Cancel an outstanding operation. OPERATION may be a number or an object which is a sub-class of Net::LDAP::Message, returned from a previous method call. yep, literally either one πŸ’…

OPTIONS is a list of key/value pairs. The following keys are recognized:

  • control => CONTROL β€” Control(s) to be passed to the operation.
  • control => [ CONTROL, .. ] β€” Control(s) to be passed to the operation.

πŸ‘€ SEE ALSO πŸ‘€

Net::LDAP, Net::LDAP::Extension β€” go read these too, bestie, iykyk 🌈

🫢 AUTHOR 🫢

Peter Marschall <peter@adpm.de>.

Please report any bugs, or post any suggestions, to the perl-ldap mailing list <perl-ldap@perl.org> πŸ›πŸ’Œ

Copyright (c) 2011 Peter Marschall. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. periodt πŸ’œ


okay that's the whole page, bestie πŸ’… β€” footer tea: this one's from perl v5.42.0, dated 2024-01-02, and it's tagged Net::LD...:Cancel(3). slay βœ¨πŸŽ€

πŸ“¦ where this page comes from