Back to index

lightning-sunbird  0.9+nobinonly
nsITransport.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Mozilla.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2002
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Darin Fisher <darin@netscape.com>
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 #include "nsISupports.idl"
00039 
00040 interface nsIInputStream;
00041 interface nsIOutputStream;
00042 interface nsITransportEventSink;
00043 interface nsIEventTarget;
00044 
00060 [scriptable, uuid(cbb0baeb-5fcb-408b-a2be-9f8fc98d0af1)]
00061 interface nsITransport : nsISupports
00062 {
00066     const unsigned long OPEN_BLOCKING   = 1<<0;
00067     const unsigned long OPEN_UNBUFFERED = 1<<1;
00068 
00100     nsIInputStream openInputStream(in unsigned long aFlags,
00101                                    in unsigned long aSegmentSize,
00102                                    in unsigned long aSegmentCount);
00103 
00135     nsIOutputStream openOutputStream(in unsigned long aFlags,
00136                                      in unsigned long aSegmentSize,
00137                                      in unsigned long aSegmentCount);
00138 
00145     void close(in nsresult aReason);
00146 
00157     void setEventSink(in nsITransportEventSink aSink,
00158                       in nsIEventTarget aEventTarget); 
00159     
00165     const unsigned long STATUS_READING = 0x804b0008;
00166     const unsigned long STATUS_WRITING = 0x804b0009;
00167 };
00168 
00169 [scriptable, uuid(EDA4F520-67F7-484b-A691-8C3226A5B0A6)]
00170 interface nsITransportEventSink : nsISupports
00171 {
00188     void onTransportStatus(in nsITransport aTransport,
00189                            in nsresult aStatus,
00190                            in unsigned long long aProgress,
00191                            in unsigned long long aProgressMax);
00192 };