/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 *
 * 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 the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  thayes@netscape.com
 *  dp@netscape.com
 *  sspitzer@netscape.com
 *
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the NPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the NPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

[scriptable, uuid(746bdcde-1dd2-11b2-b114-bf359be651fd)]
interface nsIKeyedStreamGenerator: nsISupports {
  /* information about what type of stream this generates */
  readonly attribute string signature;      
  
  /* consumer will be a nsIPasswordSink for now, but not limited to that.
   * Use NULL consumer to reset the KeyedStreamGenerator's state.
   * Also it is understood that the KeyedStreamGenerator will hold
   * only a weakreference to the consumer to avoid any circular depedencies.
   */
  void setup(in unsigned long salt, in nsISupports consumer);
    
  /* the "quality level" of this stream 
   * why a float?  if we assign 1 and 2, what do we do when something comes
   * along that is in between? 
   */
  readonly attribute float level;           
  
  /* get the byte at position "offset" in the stream */
  octet getByte(in unsigned long offset);  
};