Annotation of protozilla/ipc/public/nsIPipeFilterListener.idl, revision 1.5

1.1       saravn      1: /*
                      2:  * The contents of this file are subject to the Mozilla Public
                      3:  * License Version 1.1 (the "MPL"); you may not use this file
                      4:  * except in compliance with the MPL. You may obtain a copy of
                      5:  * the MPL at http://www.mozilla.org/MPL/
                      6:  * 
                      7:  * Software distributed under the MPL is distributed on an "AS
                      8:  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
                      9:  * implied. See the MPL for the specific language governing
                     10:  * rights and limitations under the MPL.
                     11:  * 
                     12:  * The Original Code is protoZilla.
                     13:  * 
                     14:  * The Initial Developer of the Original Code is Ramalingam Saravanan.
                     15:  * Portions created by Ramalingam Saravanan <svn@xmlterm.org> are
                     16:  * Copyright (C) 2000 Ramalingam Saravanan. All Rights Reserved.
                     17:  * 
                     18:  * Contributor(s):
                     19:  * 
                     20:  * Alternatively, the contents of this file may be used under the
                     21:  * terms of the GNU General Public License (the "GPL"), in which case
                     22:  * the provisions of the GPL are applicable instead of
                     23:  * those above. If you wish to allow use of your version of this
                     24:  * file only under the terms of the GPL and not to allow
                     25:  * others to use your version of this file under the MPL, indicate
                     26:  * your decision by deleting the provisions above and replace them
                     27:  * with the notice and other provisions required by the GPL.
                     28:  * If you do not delete the provisions above, a recipient
                     29:  * may use your version of this file under either the MPL or the
                     30:  * GPL.
                     31:  */
                     32: 
                     33: #include "nsIStreamListener.idl"
                     34: 
                     35: %{C++
                     36: #include "nsString.h"
                     37: 
                     38: #define NS_PIPEFILTERLISTENER_CLASSNAME "Pipe Filter Listener"
                     39: #define NS_PIPEFILTERLISTENER_CONTRACTID "@mozilla.org/process/pipe-filter-listener;1"
                     40:      
                     41: #define NS_PIPEFILTERLISTENER_CID                       \
                     42: { /* 8431e1b1-7ab1-11d4-8f02-006008948af5 */     \
                     43:    0x8431e1b1, 0x7ab1, 0x11d4,                   \
                     44: {0x8f, 0x02, 0x00, 0x60, 0x08, 0x94, 0x8a, 0xf5} }
                     45: 
                     46: %}
                     47: 
1.3       saravn     48: /* nsIPipeFilterListener is a filter for nsIStreamListener
1.1       saravn     49:  */
                     50: 
                     51: [scriptable, uuid(8431e1b0-7ab1-11d4-8f02-006008948af5)]
                     52: interface nsIPipeFilterListener : nsIStreamListener
                     53: {
1.5     ! saravn     54:   readonly attribute ACString startDelimiter;
        !            55: 
        !            56:   readonly attribute ACString endDelimiter;
        !            57: 
1.2       saravn     58:   /**
1.3       saravn     59:    * contains the matched start delimiter up to the end of the line,
1.5     ! saravn     60:    * including the trailing linebreak (but not the preceding linebreak)
1.2       saravn     61:    */
1.3       saravn     62:   readonly attribute ACString startLine;
1.2       saravn     63: 
                     64:   /**
1.3       saravn     65:    * contains the matched end delimiter up to the end of the line,
1.5     ! saravn     66:    * including the preceding and trailing linebreaks
1.2       saravn     67:    */
1.3       saravn     68:   readonly attribute ACString endLine;
1.2       saravn     69: 
                     70:   /**
1.3       saravn     71:    * Initializes filtering stream
1.2       saravn     72:    */
                     73: 
1.3       saravn     74:   void init(in nsIStreamListener listener, in nsISupports ctxt,
                     75:             in string startDelimiter, in string endDelimiter,
                     76:             in unsigned long skipCount,
                     77:             in boolean keepDelimiters, in boolean mimeMultipart,
                     78:             in nsIStreamListener tailListener);
1.1       saravn     79: 
                     80: 
1.3       saravn     81:   void write(in string buf, in unsigned long count,
                     82:              in nsIRequest request, in nsISupports ctxt);
1.1       saravn     83: };
                     84: 
                     85: 
                     86: ///////////////////////////////////////////////////////////////////////////////

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>