1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 *
3 * ***** BEGIN LICENSE BLOCK *****
4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 1.1 (the "License"); you may not use this file except in compliance with
8 * the License. You may obtain a copy of the License at
9 * http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * The Original Code is the mozilla.org LDAP XPCOM SDK.
17 *
18 * The Initial Developer of the Original Code is
19 * Netscape Communications Corporation.
20 * Portions created by the Initial Developer are Copyright (C) 2000
21 * the Initial Developer. All Rights Reserved.
22 *
23 * Contributor(s):
24 * Dan Mosedale <dmose@mozilla.org>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40 #include "nsISupports.idl"
41
42 interface nsILDAPMessage;
43
44 interface nsILDAPConnection;
45
46 /**
47 * A callback interface to be implemented by any objects that want to
48 * receive results from an nsILDAPOperation (ie nsILDAPMessages) as they
49 * come in.
50 */
51 [scriptable, uuid(dc721d4b-3ff2-4387-a80c-5e29545f774a)]
52 interface nsILDAPMessageListener : nsISupports
53 {
54 /**
55 * Messages received are passed back via this function.
56 *
57 * @arg aMessage The message that was returned, NULL if none was.
58 *
59 * XXX semantics of NULL?
60 */
61 void onLDAPMessage(in nsILDAPMessage aMessage);
62
63 /**
64 * Notify the listener that the Init has completed, passing
65 * in the results from the connection initialization. The
66 * Reason for this is to allow us to do asynchronous DNS
67 * lookups, preresolving hostnames.
68 *
69 * @arg aConn The LDAP connection in question
70 * @arg aStatus The result from the LDAP connection init
71 */
72 void onLDAPInit(in nsILDAPConnection aConn, in nsresult aStatus);
73 };