mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-06 00:55:37 +00:00
63 lines
2.5 KiB
Plaintext
63 lines
2.5 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape 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/NPL/
|
|
*
|
|
* 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 Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1999 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
|
|
|
|
/*
|
|
Because imap protocol connections (which are channels) run through a cache,
|
|
it isn't always the case that when you want to run a url, you actually get
|
|
a connection back right away. Often times, the url goes into a queue until
|
|
a connection becomes available.
|
|
|
|
Unfortunately, if we want to be a truly pluggable protocol with necko, necko
|
|
requires the ability to get a channel back right away when it wants to run
|
|
a url. It doesn't let you wait until an imap connection becomes available.
|
|
|
|
So I've created the notion of a "mock channel". This mock channel is what
|
|
gets returned to necko (or other callers) when they ask the imap service
|
|
for a new channel for a url. The mock channel has "mock" implementations
|
|
of nsIChannel. Eventually, when we actually assign the url to a real
|
|
channel, we set the real channel on the mock channel. From that point forward,
|
|
the mock channel forwards channel calls directly to the real channel.
|
|
|
|
In short, this class is how I'm solving the problem where necko wants
|
|
a channel back as soon as they ask for when with the fact that it
|
|
may be a while until the url is loaded into a connection.
|
|
*/
|
|
|
|
#include "nsISupports.idl"
|
|
#include "nsIChannel.idl"
|
|
|
|
interface nsIStreamListener;
|
|
interface nsIProgressEventSink;
|
|
interface nsILoadGroup;
|
|
interface nsIURI;
|
|
|
|
[scriptable, uuid(6EEC5ED3-670F-11d3-989A-001083010E9B)]
|
|
|
|
interface nsIImapMockChannel : nsIChannel
|
|
{
|
|
void GetProgressEventSink(out nsIProgressEventSink aProgressSink);
|
|
void GetChannelListener(out nsIStreamListener aChannelListener);
|
|
void GetChannelContext(out nsISupports aChannelContext);
|
|
void Close();
|
|
};
|