Back to index

lightning-sunbird  0.9+nobinonly
nsLDAPChannel.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  * 
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is the mozilla.org LDAP XPCOM SDK.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 2000
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Dan Mosedale <dmose@mozilla.org>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #ifndef nsLDAPChannel_h__
00041 #define nsLDAPChannel_h__
00042 
00043 #include "nsCOMPtr.h"
00044 #include "nsIRunnable.h"
00045 #include "nsIThread.h"
00046 #include "nsIChannel.h"
00047 #include "nsILoadGroup.h"
00048 #include "nsIInputStream.h"
00049 #include "nsIOutputStream.h"
00050 #include "nsIInterfaceRequestor.h"
00051 #include "nsIInterfaceRequestorUtils.h"
00052 #include "nsIStreamListener.h"
00053 #include "nsILDAPConnection.h"
00054 #include "nsILDAPOperation.h"
00055 #include "nsILDAPMessageListener.h"
00056 #include "nsIProgressEventSink.h"
00057 #include "nsILDAPURL.h"
00058 
00059 // if the code related to the following #define ever gets removed, also
00060 // be sure to remove mCallback as well as the most (but not all) of the 
00061 // various mUnproxied stuff
00062 //
00063 #define INVOKE_LDAP_CALLBACKS_ON_MAIN_THREAD 0
00064 
00065 class nsLDAPChannel : public nsIChannel, public nsILDAPMessageListener
00066 {
00067   public:
00068     NS_DECL_ISUPPORTS
00069     NS_DECL_NSIREQUEST
00070     NS_DECL_NSICHANNEL
00071     NS_DECL_NSILDAPMESSAGELISTENER
00072 
00073     nsLDAPChannel();
00074     virtual ~nsLDAPChannel();
00075 
00076     nsresult Init(nsIURI *uri);
00077 
00078     // this actually only gets called by nsLDAPHandler::NewChannel()
00079     //
00080     static NS_METHOD
00081        Create(nsISupports* aOuter, REFNSIID aIID, void **aResult);
00082 
00083   protected:
00084 
00085     // these are internal functions, called by the dispatcher function
00086     // OnLDAPMessage()
00087     //
00088     nsresult OnLDAPSearchResult(nsILDAPMessage *aMessage);
00089     nsresult OnLDAPSearchEntry(nsILDAPMessage *aMessage);
00090     nsresult OnLDAPBind(nsILDAPMessage *aMessage);
00091 
00092     // instance vars for read/write nsIChannel attributes
00093     //
00094     nsresult mStatus;
00095     nsCOMPtr<nsIURI> mURI;         // the URI we're processing
00096     nsCOMPtr<nsILoadGroup> mUnproxiedLoadGroup; // the load group we belong to
00097     nsCOMPtr<nsIInterfaceRequestor> mCallbacks; 
00098     nsCOMPtr<nsIURI> mOriginalURI; // the URI we started processing
00099     nsLoadFlags mLoadFlags;        // load attributes for this channel
00100     nsCOMPtr<nsISupports> mOwner;  // entity responsible for this channel
00101 
00102     // various other instance vars
00103     //
00104     nsCOMPtr<nsIStreamListener> mUnproxiedListener; // for calls on main thread
00105     nsCOMPtr<nsILoadGroup> mLoadGroup; // possibly an nsISupports proxy
00106     nsCOMPtr<nsILDAPConnection> mConnection; // LDAP connection
00107     nsCOMPtr<nsIStreamListener> mListener; // for calls on LDAP callback thread
00108     // which _might_ be the main thread
00109     nsCOMPtr<nsISupports> mResponseContext; 
00110     nsCOMPtr<nsIInputStream> mReadPipeIn; // this end given to the listener
00111     nsCOMPtr<nsIOutputStream> mReadPipeOut; // for writes from the channel
00112     nsCOMPtr<nsILDAPOperation> mCurrentOperation; // current ldap operation
00113     PRUint32 mReadPipeOffset; // how many bytes written so far?
00114     PRBool mReadPipeClosed; // has the pipe already been closed?
00115     nsCOMPtr<nsILDAPMessageListener> mCallback; // callback
00116     nsCOMPtr<nsIProgressEventSink> mEventSink; // fire status against this
00117 
00118 };
00119 
00120 #endif // nsLDAPChannel_h__