/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set sw=2 ts=8 et tw=80 : */ /* ***** BEGIN LICENSE BLOCK ***** * Version: MPL 1.1/GPL 2.0/LGPL 2.1 * * The contents of this file are subject to the Mozilla Public License Version * 1.1 (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License * for the specific language governing rights and limitations under the * License. * * The Original Code is mozilla.org code. * * The Initial Developer of the Original Code is * The Mozilla Foundation * Portions created by the Initial Developer are Copyright (C) 2009 * the Initial Developer. All Rights Reserved. * * Contributor(s): * Jason Duell * Daniel Witte * Honza Bambas * * Alternatively, the contents of this file may be used under the terms of * either the GNU General Public License Version 2 or later (the "GPL"), or * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), * in which case the provisions of the GPL or the LGPL are applicable instead * of those above. If you wish to allow use of your version of this file only * under the terms of either the GPL or the LGPL, and not to allow others to * use your version of this file under the terms of the MPL, indicate your * decision by deleting the provisions above and replace them with the notice * and other provisions required by the GPL or the LGPL. If you do not delete * the provisions above, a recipient may use your version of this file under * the terms of any one of the MPL, the GPL or the LGPL. * * ***** END LICENSE BLOCK ***** */ #ifndef mozilla_net_HttpChannelChild_h #define mozilla_net_HttpChannelChild_h #include "mozilla/net/HttpBaseChannel.h" #include "mozilla/net/PHttpChannelChild.h" #include "mozilla/net/ChannelEventQueue.h" #include "nsIStreamListener.h" #include "nsILoadGroup.h" #include "nsIInterfaceRequestor.h" #include "nsIInterfaceRequestorUtils.h" #include "nsIProgressEventSink.h" #include "nsICacheInfoChannel.h" #include "nsIApplicationCache.h" #include "nsIApplicationCacheChannel.h" #include "nsIUploadChannel2.h" #include "nsIResumableChannel.h" #include "nsIProxiedChannel.h" #include "nsIAsyncVerifyRedirectCallback.h" #include "nsIAssociatedContentSecurity.h" #include "nsIChildChannel.h" #include "nsIHttpChannelChild.h" namespace mozilla { namespace net { class HttpChannelChild : public PHttpChannelChild , public HttpBaseChannel , public HttpAsyncAborter , public nsICacheInfoChannel , public nsIProxiedChannel , public nsIApplicationCacheChannel , public nsIAsyncVerifyRedirectCallback , public nsIAssociatedContentSecurity , public nsIChildChannel , public nsIHttpChannelChild { public: NS_DECL_ISUPPORTS_INHERITED NS_DECL_NSICACHEINFOCHANNEL NS_DECL_NSIPROXIEDCHANNEL NS_DECL_NSIAPPLICATIONCACHECONTAINER NS_DECL_NSIAPPLICATIONCACHECHANNEL NS_DECL_NSIASYNCVERIFYREDIRECTCALLBACK NS_DECL_NSIASSOCIATEDCONTENTSECURITY NS_DECL_NSICHILDCHANNEL NS_DECL_NSIHTTPCHANNELCHILD HttpChannelChild(); virtual ~HttpChannelChild(); // Methods HttpBaseChannel didn't implement for us or that we override. // // nsIRequest NS_IMETHOD Cancel(nsresult status); NS_IMETHOD Suspend(); NS_IMETHOD Resume(); // nsIChannel NS_IMETHOD GetSecurityInfo(nsISupports **aSecurityInfo); NS_IMETHOD AsyncOpen(nsIStreamListener *listener, nsISupports *aContext); // HttpBaseChannel::nsIHttpChannel NS_IMETHOD SetRequestHeader(const nsACString& aHeader, const nsACString& aValue, bool aMerge); // nsIHttpChannelInternal NS_IMETHOD SetupFallbackChannel(const char *aFallbackKey); NS_IMETHOD GetLocalAddress(nsACString& addr); NS_IMETHOD GetLocalPort(PRInt32* port); NS_IMETHOD GetRemoteAddress(nsACString& addr); NS_IMETHOD GetRemotePort(PRInt32* port); // nsISupportsPriority NS_IMETHOD SetPriority(PRInt32 value); // nsIResumableChannel NS_IMETHOD ResumeAt(PRUint64 startPos, const nsACString& entityID); // IPDL holds a reference while the PHttpChannel protocol is live (starting at // AsyncOpen, and ending at either OnStopRequest or any IPDL error, either of // which call NeckoChild::DeallocPHttpChannel()). void AddIPDLReference(); void ReleaseIPDLReference(); bool IsSuspended(); protected: bool RecvOnStartRequest(const nsHttpResponseHead& responseHead, const bool& useResponseHead, const nsHttpHeaderArray& requestHeaders, const bool& isFromCache, const bool& cacheEntryAvailable, const PRUint32& cacheExpirationTime, const nsCString& cachedCharset, const nsCString& securityInfoSerialization, const PRNetAddr& selfAddr, const PRNetAddr& peerAddr); bool RecvOnTransportAndData(const nsresult& status, const PRUint64& progress, const PRUint64& progressMax, const nsCString& data, const PRUint32& offset, const PRUint32& count); bool RecvOnStopRequest(const nsresult& statusCode); bool RecvOnProgress(const PRUint64& progress, const PRUint64& progressMax); bool RecvOnStatus(const nsresult& status); bool RecvFailedAsyncOpen(const nsresult& status); bool RecvRedirect1Begin(const PRUint32& newChannel, const URI& newURI, const PRUint32& redirectFlags, const nsHttpResponseHead& responseHead); bool RecvRedirect3Complete(); bool RecvAssociateApplicationCache(const nsCString& groupID, const nsCString& clientID); bool RecvDeleteSelf(); bool GetAssociatedContentSecurity(nsIAssociatedContentSecurity** res = nsnull); virtual void DoNotifyListenerCleanup(); private: RequestHeaderTuples mClientSetRequestHeaders; nsCOMPtr mRedirectChannelChild; nsCOMPtr mSecurityInfo; bool mIsFromCache; bool mCacheEntryAvailable; PRUint32 mCacheExpirationTime; nsCString mCachedCharset; // If ResumeAt is called before AsyncOpen, we need to send extra data upstream bool mSendResumeAt; bool mIPCOpen; bool mKeptAlive; // IPC kept open, but only for security info ChannelEventQueue mEventQ; // true after successful AsyncOpen until OnStopRequest completes. bool RemoteChannelExists() { return mIPCOpen && !mKeptAlive; } void AssociateApplicationCache(const nsCString &groupID, const nsCString &clientID); void OnStartRequest(const nsHttpResponseHead& responseHead, const bool& useResponseHead, const nsHttpHeaderArray& requestHeaders, const bool& isFromCache, const bool& cacheEntryAvailable, const PRUint32& cacheExpirationTime, const nsCString& cachedCharset, const nsCString& securityInfoSerialization, const PRNetAddr& selfAddr, const PRNetAddr& peerAddr); void OnTransportAndData(const nsresult& status, const PRUint64 progress, const PRUint64& progressMax, const nsCString& data, const PRUint32& offset, const PRUint32& count); void OnStopRequest(const nsresult& statusCode); void OnProgress(const PRUint64& progress, const PRUint64& progressMax); void OnStatus(const nsresult& status); void FailedAsyncOpen(const nsresult& status); void HandleAsyncAbort(); void Redirect1Begin(const PRUint32& newChannelId, const URI& newUri, const PRUint32& redirectFlags, const nsHttpResponseHead& responseHead); void Redirect3Complete(); void DeleteSelf(); // Called asynchronously from Resume: continues any pending calls into client. void CompleteResume(); friend class AssociateApplicationCacheEvent; friend class StartRequestEvent; friend class StopRequestEvent; friend class TransportAndDataEvent; friend class ProgressEvent; friend class StatusEvent; friend class FailedAsyncOpenEvent; friend class Redirect1Event; friend class Redirect3Event; friend class DeleteSelfEvent; friend class HttpAsyncAborter; }; //----------------------------------------------------------------------------- // inline functions //----------------------------------------------------------------------------- inline bool HttpChannelChild::IsSuspended() { return mSuspendCount != 0; } } // namespace net } // namespace mozilla #endif // mozilla_net_HttpChannelChild_h