Back to index

lightning-sunbird  0.9+nobinonly
nsIImapMockChannel.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 
00039 /*
00040     Because imap protocol connections (which are channels) run through a cache,
00041     it isn't always the case that when you want to run a url, you actually get
00042     a connection back right away. Often times, the url goes into a queue until
00043     a connection becomes available.
00044 
00045     Unfortunately, if we want to be a truly pluggable protocol with necko, necko
00046     requires the ability to get a channel back right away when it wants to run 
00047     a url. It doesn't let you wait until an imap connection becomes available.
00048 
00049     So I've created the notion of a "mock channel". This mock channel is what
00050     gets returned to necko (or other callers) when they ask the imap service
00051     for a new channel for a url. The mock channel has "mock" implementations
00052     of nsIChannel. Eventually, when we actually assign the url to a real
00053     channel, we set the real channel on the mock channel. From that point forward,
00054     the mock channel forwards channel calls directly to the real channel.
00055 
00056     In short, this class is how I'm solving the problem where necko wants
00057     a channel back as soon as they ask for when with the fact that it
00058     may be a while until the url is loaded into a connection.
00059  */
00060 
00061 #include "nsISupports.idl"
00062 #include "nsIChannel.idl"
00063 
00064 interface nsIStreamListener;
00065 interface nsIProgressEventSink;
00066 interface nsIURI;
00067 interface nsIImapProtocol;
00068 
00069 [scriptable, uuid(e0178cd5-d37b-4bde-9ab8-752083536225)]
00070 
00071 interface nsIImapMockChannel : nsIChannel
00072 {
00073   attribute nsIProgressEventSink progressEventSink;
00074   void GetChannelListener(out nsIStreamListener aChannelListener);
00075   void GetChannelContext(out nsISupports aChannelContext);
00076   void Close();
00077   void setImapProtocol(in nsIImapProtocol aProtocol);
00078   [noscript] void setSecurityInfo(in nsISupports securityInfo);
00079 
00080   void setURI(in nsIURI uri);
00081 };