Back to index

lightning-sunbird  0.9+nobinonly
nsIHttpActivityObserver.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 IBM Corporation.
00017  * Portions created by IBM Corporation are Copyright (C) 2003
00018  * IBM Corporation. All Rights Reserved.
00019  *
00020  * Contributor(s):
00021  *   IBM Corp.
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #include "nsISupports.idl"
00038 
00039 
00046 [scriptable, uuid(412880C8-6C36-48d8-BF8F-84F91F892503)]
00047 interface nsIHttpActivityObserver : nsISupports
00048 {
00080     void observeActivity(in nsISupports  aHttpChannel,
00081                          in PRUint32     aActivityType,
00082                          in PRUint32     aActivitySubtype,
00083                          in PRTime       aTimestamp,
00084                          in PRUint64     aExtraSizeData,
00085                          in ACString     aExtraStringData);
00086 
00092     readonly attribute boolean isActive;
00093 
00094     const unsigned long ACTIVITY_TYPE_SOCKET_TRANSPORT     = 0x0001;
00095     const unsigned long ACTIVITY_TYPE_HTTP_TRANSACTION     = 0x0002;
00096 
00097     const unsigned long ACTIVITY_SUBTYPE_REQUEST_HEADER    = 0x5001;
00098     const unsigned long ACTIVITY_SUBTYPE_REQUEST_BODY_SENT = 0x5002;
00099     const unsigned long ACTIVITY_SUBTYPE_RESPONSE_START    = 0x5003;
00100     const unsigned long ACTIVITY_SUBTYPE_RESPONSE_HEADER   = 0x5004;
00101     const unsigned long ACTIVITY_SUBTYPE_RESPONSE_COMPLETE = 0x5005;
00102     const unsigned long ACTIVITY_SUBTYPE_TRANSACTION_CLOSE = 0x5006;
00103 
00124 };
00125 
00126 %{C++
00127 
00128 #define NS_HTTPACTIVITYOBSERVER_TOPIC \
00129   "http-activity-observer"
00130 
00131 #define NS_HTTPACTIVITYDISTRIBUTOR_CONTRACTID \
00132   "@mozilla.org/netwerk/protocol/http/http-activity-distributor;1"
00133 
00134 #define NS_HTTP_ACTIVITY_TYPE_SOCKET_TRANSPORT    \
00135             nsIHttpActivityObserver::ACTIVITY_TYPE_SOCKET_TRANSPORT
00136 #define NS_HTTP_ACTIVITY_TYPE_HTTP_TRANSACTION    \
00137             nsIHttpActivityObserver::ACTIVITY_TYPE_HTTP_TRANSACTION
00138 
00139 #define NS_HTTP_ACTIVITY_SUBTYPE_REQUEST_HEADER    \
00140             nsIHttpActivityObserver::ACTIVITY_SUBTYPE_REQUEST_HEADER
00141 #define NS_HTTP_ACTIVITY_SUBTYPE_REQUEST_BODY_SENT \
00142             nsIHttpActivityObserver::ACTIVITY_SUBTYPE_REQUEST_BODY_SENT
00143 #define NS_HTTP_ACTIVITY_SUBTYPE_RESPONSE_START    \
00144             nsIHttpActivityObserver::ACTIVITY_SUBTYPE_RESPONSE_START
00145 #define NS_HTTP_ACTIVITY_SUBTYPE_RESPONSE_HEADER   \
00146             nsIHttpActivityObserver::ACTIVITY_SUBTYPE_RESPONSE_HEADER
00147 #define NS_HTTP_ACTIVITY_SUBTYPE_RESPONSE_COMPLETE \
00148             nsIHttpActivityObserver::ACTIVITY_SUBTYPE_RESPONSE_COMPLETE
00149 #define NS_HTTP_ACTIVITY_SUBTYPE_TRANSACTION_CLOSE \
00150             nsIHttpActivityObserver::ACTIVITY_SUBTYPE_TRANSACTION_CLOSE
00151 
00152 %}