1999-06-08 01:33:30 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Netscape Public License
|
|
|
|
* Version 1.0 (the "NPL"); you may not use this file except in
|
|
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
|
|
* http://www.mozilla.org/NPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* NPL.
|
|
|
|
*
|
|
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
|
|
* Communications Corporation. Portions created by Netscape are
|
|
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
|
|
|
* Reserved.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
|
|
|
|
interface nsIProtocolHandler;
|
|
|
|
interface nsIURI;
|
|
|
|
interface nsIEventSinkGetter;
|
|
|
|
interface nsIChannel;
|
1999-06-12 12:07:05 +04:00
|
|
|
interface nsIStreamObserver;
|
|
|
|
interface nsIStreamListener;
|
|
|
|
interface nsIEventQueue;
|
|
|
|
interface nsIBufferInputStream;
|
1999-06-29 00:37:10 +04:00
|
|
|
interface nsIInputStream;
|
1999-06-15 09:18:40 +04:00
|
|
|
interface nsIBufferOutputStream;
|
1999-06-16 08:15:22 +04:00
|
|
|
interface nsIFileChannel;
|
1999-06-25 02:58:42 +04:00
|
|
|
interface nsILoadGroup;
|
1999-06-08 01:33:30 +04:00
|
|
|
|
|
|
|
[scriptable, uuid(01f0a170-1881-11d3-9337-00104ba0fd40)]
|
|
|
|
interface nsIIOService : nsISupports
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Returns a protocol handler for a given URI scheme.
|
|
|
|
*/
|
|
|
|
nsIProtocolHandler GetProtocolHandler(in string scheme);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns an absolute URI string from a relative specification and
|
|
|
|
* a base URI.
|
|
|
|
*/
|
|
|
|
string MakeAbsolute(in string aRelativeSpec, in nsIURI aBaseURI);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* This method constructs a new URI by first determining the scheme
|
|
|
|
* of the URI spec, and then delegating the construction of the URI
|
|
|
|
* to the protocol handler for that scheme. QueryInterface can be used
|
|
|
|
* on the resulting URI object to obtain a more specific type of URI.
|
|
|
|
*/
|
|
|
|
nsIURI NewURI(in string aSpec, in nsIURI aBaseURI);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Creates a channel for a given URI. The eventSinkGetter is used to
|
|
|
|
* obtain the appropriate callbacks for the URI's protocol from the
|
|
|
|
* application.
|
|
|
|
*/
|
|
|
|
nsIChannel NewChannelFromURI(in string verb,
|
|
|
|
in nsIURI aURI,
|
|
|
|
in nsIEventSinkGetter eventSinkGetter);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Convenience routine that first creates a URI by calling NewURI, and
|
|
|
|
* then passes the URI to NewChannelFromURI.
|
|
|
|
*/
|
|
|
|
nsIChannel NewChannel(in string verb,
|
|
|
|
in string aSpec,
|
|
|
|
in nsIURI aBaseURI,
|
|
|
|
in nsIEventSinkGetter eventSinkGetter);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the application name string that will be used as part
|
|
|
|
* of a HTTP request.
|
|
|
|
*/
|
1999-06-08 23:04:13 +04:00
|
|
|
readonly attribute wstring AppCodeName;
|
1999-06-08 01:33:30 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the application version string that will be used as part
|
|
|
|
* of a HTTP request.
|
|
|
|
*/
|
1999-06-08 23:04:13 +04:00
|
|
|
readonly attribute wstring AppVersion;
|
1999-06-08 01:33:30 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the application name.
|
|
|
|
*/
|
1999-06-08 23:04:13 +04:00
|
|
|
readonly attribute wstring AppName;
|
1999-06-08 01:33:30 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the translation of the application. The value for language
|
|
|
|
* is usually a 2-letter code such as "en" and occasionally a
|
|
|
|
* five-character code to indicate a language subtype, such as "zh_CN".
|
|
|
|
*/
|
1999-06-08 23:04:13 +04:00
|
|
|
readonly attribute wstring Language;
|
1999-06-08 01:33:30 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the current platform (machine type).
|
|
|
|
*/
|
1999-06-08 23:04:13 +04:00
|
|
|
readonly attribute wstring Platform;
|
1999-06-08 01:33:30 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the HTTP advertised user agent string.
|
|
|
|
*/
|
1999-06-08 23:04:13 +04:00
|
|
|
readonly attribute wstring UserAgent;
|
1999-06-08 01:33:30 +04:00
|
|
|
|
1999-06-12 12:07:05 +04:00
|
|
|
/**
|
|
|
|
* Returns a new stream observer that marshals data from another
|
|
|
|
* stream observer over to the thread specified by an event queue.
|
|
|
|
*/
|
|
|
|
nsIStreamObserver NewAsyncStreamObserver(in nsIStreamObserver receiver,
|
|
|
|
in nsIEventQueue eventQueue);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* An asynchronous stream listener is used to ship data over to another thread specified
|
|
|
|
* by the thread's event queue. The receiver stream listener is then used to receive
|
|
|
|
* the data on the other thread.
|
|
|
|
*/
|
|
|
|
nsIStreamListener NewAsyncStreamListener(in nsIStreamListener receiver,
|
|
|
|
in nsIEventQueue eventQueue);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A synchronous stream listener pushes data through a pipe that ends up
|
|
|
|
* in an input stream to be read by another thread.
|
|
|
|
*/
|
1999-06-29 00:37:10 +04:00
|
|
|
nsIStreamListener NewSyncStreamListener(out nsIInputStream inStream,
|
1999-06-15 09:18:40 +04:00
|
|
|
out nsIBufferOutputStream outStream);
|
1999-06-12 12:07:05 +04:00
|
|
|
|
1999-06-16 08:15:22 +04:00
|
|
|
/**
|
|
|
|
* This convenience routine first looks up the file protocol handler, and
|
|
|
|
* then uses it to construct a file channel from a native path string.
|
|
|
|
*/
|
|
|
|
nsIFileChannel NewChannelFromNativePath(in string nativePath);
|
1999-06-25 02:58:42 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns a new load group. Load groups can be used to manage collections
|
|
|
|
* of channels so that they can be reloaded or canceled en mass. Note that
|
|
|
|
* their use is not required by other parts of the system, they are primarily
|
|
|
|
* a convenience for the caller.
|
|
|
|
*/
|
|
|
|
nsILoadGroup NewLoadGroup();
|
1999-06-08 01:33:30 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
%{C++
|
|
|
|
|
|
|
|
#define NS_IOSERVICE_CID \
|
|
|
|
{ /* 9ac9e770-18bc-11d3-9337-00104ba0fd40 */ \
|
|
|
|
0x9ac9e770, \
|
|
|
|
0x18bc, \
|
|
|
|
0x11d3, \
|
|
|
|
{0x93, 0x37, 0x00, 0x10, 0x4b, 0xa0, 0xfd, 0x40} \
|
|
|
|
}
|
|
|
|
|
|
|
|
%}
|